Skip to content

Latest commit

 

History

History
114 lines (77 loc) · 5.1 KB

Contributor_Guidelines.md

File metadata and controls

114 lines (77 loc) · 5.1 KB

Contributing Guidelines - W.A.K

Thank you for taking interest in W.A.K! You will find all the information you need to contribute to this project below.

How to file a bug report

If you come across any bugs, please create a new issue by following the steps below:

  • First check if the issue has already been reported by searching on our issues page
  • If the issue has not been reported, click on the New Issue button
  • Select the Bug Report template
  • Fill in the template with as much detail as possible and click Submit new issue
  • A maintainer will review your issue and respond as soon as possible and will let you know if any additional information is required

How to suggest a new feature

If you have an idea for a new feature, please create a new issue by following the steps below:

  • First check if the feature has already been suggested by searching on our issues page
  • If the feature has not been suggested, click on the New Issue button
  • Select the Feature Request template
  • Fill in the template with as much detail as possible and click Submit new issue
  • A maintainer will review your issue and respond as soon as possible and will let you know if any additional information is required

Issue Approval Process

For new feature requests or bug reports that are not part of the initial set of tasks, our team will review the issue and approve it before it is worked on. This is to ensure that the issue is valid and that the team has the capacity to work on it.

How to submit a pull request

If you would like to contribute changes to this project, first fork and clone the main repository. For each issue that you work on:

  • Assign yourself to the issue. Make sure no other user is an assignee unless you have communicated with them prior.
  • Create a new branch for the issue in your fork. Ensure that the branch name is descriptive.
  • Work on the changes, add or modify any tests as needed and commit to your fork branch.
  • Commit your changes with a descriptive commit message.
  • Open a pull request to the main repository. Include a reference to the issue number. And add a description of the changes you made.
  • A team member will review the pull request as soon as possible.

How to set up your environment and run tests

To set up your environment, follow the steps below:

  • Clone the repository
  • Install the dependencies by running npm run installAll in the root directory
  • Reach out to our Lead Developer Dhruvkanth for the env folders, and place them inside client folder and server folder as '.env' form
  • Finally, create two separate terminal one for the client folder and one for the server folder and navigate to the 2 folders respectively. Run the following command in both the terminals
  • We used User Testing to test our application. We asked our friends to use our application and give us feedback.
npm run dev
  • Finally, after connection, you will get an HTTP link inside client terminal, click and run the web application

The types of contributions

We welcome all contributions to this project, however we kindly ask you to follow our CODE OF CONDUCT when contributing. Types of contributions includes:

  • Bug fixes
  • New features
  • Improvements to existing features
  • Improvements to documentation
  • Improvements to code quality
  • Many more!

How contributors can get started if they are newcomers

  • Check out the issues page
  • Assign yourself to an issue, please assign yourself to a maximum of 1 issue at a time
  • If you have any questions, please reach out to our team using the contact information below..

Technical requirements for contributions

  • Must be able to use Git and GitHub
  • Must be familiar with JavaScript, React, Node.js, Express.js, MongoDB, HTML, CSS
  • Follow good coding practices

Your roadmap or vision for the project

We want to work on the features that are planned for the next release. We will be working on the following features:

Version 2.0.0

  • Customize theme of website based on their fave movie
  • Favourites list
  • Add friends/other users
  • Shared list with friends

Version 3.0.0

  • Sign in with Google/facebook
  • Custom ratings for shared friends list
  • Dynamic list that recommends users movies based on their favourites

High level design / architecture design information

We use TMDB API to get the movie data and use MongoDB to store the user data. We use React for the front-end and Node.js for the back-end. We use Express.js to create the REST API. We use Jest for testing.

Project ground rules like expected behaviour

Code of Conduct: All contributors must follow our Code of Conduct.

Contact Us

Name Email
Dhruvkanth Puli [email protected]
Kevin Jin [email protected]
Aditya Sohani [email protected]
Adwait Mane [email protected]
Young Min Kim [email protected]
Eric Jiang [email protected]