Skip to content

CONTRIBUTION_GUIDELINES.md

Latest commit

 

History

History
19 lines (13 loc) · 1.46 KB

CONTRIBUTION_GUIDELINES.md

File metadata and controls

19 lines (13 loc) · 1.46 KB

Contribution Guidelines

You'll only be able to contribute to this repository if you have a GitHub account. Go ahead and make one if you haven't yet.

  1. Fork the repository
  2. Make changes
  3. Submit a pull request
  4. Follow up on comments
  5. Repeat

Fork

Follow this guide to fork the repository. This will allow you to work on a version of the project without your commits interfering with the production version of the project. In order to keep up to date with the main repository, everytime you are working on a new feature/section of the project, fork the main repository into a new local branch.

Changes

We want this code to be easy to understand. Make sure to leave plenty of comments in your code. We're making the specifics of the project very flexible, so feel free to be creative. When you are setting up a new framework/API/database make sure to add information on how to set it up a similar environment in the project's README.md file.

Pull Request

When you are satisfied with whatever part of the project you were working on, send a pull request to the main repository. Make sure to include a summary of what revisions you have made as well as screenshots if appropriate. Take a look at this to learn how to send pull requests. Once your pull request is reviewed, we will leave comments on changes we think are appropriate or we will merge your change.