CodingGuidelines

Coding guidelines

During a development Sprint, you should follow all guidelines listed below. In case you find a guideline irrelevant or impractical to follow, it is your responsibility to let us know.

• Commit (and push) frequently. You should commit quite often (upon each increment of functionality that you implement), and push to GitHub regularly as well.
• Each commit should reference an issue. Suppose you have defined an issue with id 123, the commit message should, for example, look like this:

> git commit -am "Work on #123"

Note that this guideline implies that you should only work on issues that were previously defined in GitHub.

• Each issue should be defined within a milestone. The project milestones should be defined in coordination with Oren.
• A finished issue should be closed. Note that issue may be closed directly from the comment of the commit:

> git commit -am "Close #123"