-
Notifications
You must be signed in to change notification settings - Fork 5
Contribution
Matti Bar-Zeev edited this page Dec 2, 2013
·
6 revisions
Contribution is currently done on the "develop" branch. Here are the steps you need to take in order to contribute code to this project. It's critical that you follow these steps and convention, for your pull request to be merged into the code.
- Fork the project on the "develop" branch.
- Make your code modifications.
- Run grunt from the project's root directory. This will make sure you don't have any embarrassing code errors and will run unit tests** (including those you've implemented for the contribution) and make sure it all passes.
- launch the server and see that everything is working as you expect it to.
- Commit your changes. Try to create small commits as possible (by "small" I mean, avoid missing unrelated code modifications). Make sure you use the commit message conventions.
- Open a Pull Request and submit you're changes.
- Ongoing - This means features, re-factoring, optimizing
- Fix - This means anything you fix, whether it is an issue, a JSHint error etc.
- Merge - This means that you've merged something to your branch.
- Tidy Up - This means cleaning up the code, deleting comments, cleaning console outputs, etc.
If you're attending an issue, make sure you mention it on your commit, e.g.:
Ongoing: Implementing enhancement issue #15