Contribution Guidelines

Pull requests

Pull requests are the preferred way of contributing. Github has a nice article about this. Be sure to read it. Generally, you can follow these steps :

• Create a dedicated branch based on latest master for your pull request.
• Commit on this branch, or add commits by cherry-picking them.
• Submit the pull request.
• Once your branch is merged, you can delete it.
• If master changes before your branch is merged, do not merge master into it, rebase.

Changes

• Do not comment code, remove it. It is Git's job to keep track of history.
• Keep the changes to the bare minimal as possible, or make several commits.
• In class files, do not forget to increase the revision number (the number just after the patch number).

Whitespaces

• Use only tabulations (width 4) to indent. Do not insert spaces in between tabulations.
• Use spaces to align similar items on consecutive lines.
• Align numbers to the right; spaces between initial indent and numbers are allowed in this case.
• Always remove trailing whitespaces.
• Always keep an empty line at the end of the file.

Ordering

• Order the spells by number (this helps spot duplicates),
• Simple numbers go first, then nested lists,
• Keep similar lines together.