Commit policy

Table of Contents Scary Legal Stuff Commit Rules Commit Steps Good Practice Merging

Scary Legal Stuff

• Please be aware that any code you commit to our projects becomes the property of the OTW and will be licensed under The GNU General Public License. No take-backs. :) Don't commit code if you're not willing for it to be shared forever!
• Never commit code you didn't write yourself or code that doesn't have a suitable license. If you are adding code written by someone else (for instance a third-party Rails plugin), it must have been released under a license that is the same or *more* permissive than our own license. Please do specify in your commit message how the plugin is licensed.
• Never remove licensing info from code.
• Never use a decompiler or disassembler to look at proprietary code.

Commit Rules

• One thing at a time. Don't commit unrelated changes together, or a change and a fix at the same time.
• Make sure that you are committing only the files you need.
• Make sure your code matches the Coding Standards.
• Send in your code as a pull request on Github.

Commit Steps

1. Do an update from upstream master and fix any conflicts.
2. Run 'rake cucumber' to make sure all the tests work. If anything fails, contact someone for help.
3. When committing, add a changelog entry with a meaningful explanation and the Google Code issue number.
4. If you have finished fixing a bug or implementing a feature, update the Google Code bug tracking database with the status "SubmittedPullRequest" with the link to the pull request.
5. Do something nice for yourself! :)

Good Practice

• Update source frequently
• If you are fixing or changing something without an issue, open one so that your change can be tested and tracked.
• After you have created a migration and it has been tested, run

 rake schema:dump

and commit the resultant db/schema.rb file

Merging

Right now, Naomi, Sidra and Elz are doing code review and then merging everybody else's stuff. Any coders with merge permissions are welcome to review/merge senior coders' pull requests. Drive-by code review and discussion of anybody else's code is always welcome - we can all learn more - but please remember to keep it constructive.