Skip to content

Latest commit

 

History

History
16 lines (10 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

16 lines (10 loc) · 1.63 KB

Contributing

If you would like to begin contributing to Calagator, this is the workflow.

1. Work on the project in your own fork. For info on how to do that, see [this](https://help.github.com/articles/fork-a-repo/).
2. For each feature you work on, work in a fresh branch of your fork. So, if you're working on improving test coverage for a specific file **and** implementing something new, they would each have their own branch. To learn about branching and how it works in GitHub, go [here](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/).
3. Once you've finished and tested your work, [create a Pull Request (PR)](https://help.github.com/articles/using-pull-requests/#initiating-the-pull-request), explain what your work does, and reference the original ticket if that is relevant. You should be able to do this simply by typing the ticket number into the Pull Request UI.
4. Once you submit your Pull Request, Travis CI will begin running and ensure your code is compatable. Results will automatically be reported back to your PR when complete. The goal is for all the tests to pass and for overall test coverage to not decrease.

Code of Conduct

If this is your first time working on Calagator, or you feel like you need a refresher, please take a look at our Code of Conduct. It's important that we respect all our contributors, and following the CoC will help ensure that stays true.

Contributor List

If it is your first time working on Calagator, we encourage you to add your name to the CONTRIBUTORS.md file along with your PR.