Code style guidelines
- Use unix line endings. If you are on windows, use a text editor writes/reads unix line endings
- Use 4 spaces for indentation. Don't use tabs, and especially not a mix of tabs and spaces. Configure your editor to handle this
- Avoid leaving commented out code in the codebase.
- Use consistent comma style. Prefer not using comma-first style
- Use consistent spacing surrounding if statements (e.g. choose if( condition ) or if (condition))
- Use curly brackets on all blocks, don't rely on the fact that you can avoid it in the single line case
Git guidelines
- Review your commits before pushing to server with git log -p.
- Use git commit --amend to fix any errors with your commits before pushing.
- Use git pull --rebase during normal branch development to avoid unnecessary merge commits
- Avoid mixing formatting changes with functional changes.
- Do not force push to the repo.
Github guidelines
- Use pull requests if you have a set of changes that you want someone to review.
- Update ChangeLog.md as soon as fixes are made.
- Reference issue numbers from ChangeLog.md as much as possible.
- Be nice to everyone! Be courteous!
- Try and comment on github issues that users create to acknowledge them
Commit message guidelines
- Avoid spelling errors
- Reference issue numbers in the commit message as much as possible (simply type "See #147")
- Say what you did as best as possible. Don't just say "fixed it" or "works now".
JavaScript guidelines
- Run jshint or eslint on your code. Note that jscs is superseded by eslint, which can do style checking too
Mailing list issues
- If we have a easy question, feel free to take it and respond.
- If it is a complicated question, or you think it will take awhile to respond, then let the group know that you want to "take" the message.