Development Team/Commit Guidelines

Revision as of 01:42, 9 June 2009

All developers should adhere to the following guidelines when making commits to any of DareNET's projects.

• ALWAYS add a ChangeLog entry with a meaningful explanation.
• If you fix a bug, we ask that you also add a regression test for it in the test suite.
• When fixing bugs, don't blindly follow the documentation, it may well be wrong. Test the behavior or ask on the list for discussion if unsure. Don't be afraid of having your changes reviewed.
• Do a regression test run if making changes to core functionality before committing.
• Don't commit unrelated changes together with a fix: do fine-grained commits.
• Always check that you're committing: make sure you're only committing what you need and make sure you don't change line endings and white space. Do a svn diff of the files you're going to commit and check the changes.
• Don't do reformatting commits, unless you're the original author of the code or have obtained permission from the project maintainer.
• Never remove copyright notices from the code.
• Never remove licensing info from the code.
• Never commit code you didn't write yourself or code that doesn't have a suitable license.
• Follow the coding guidelines.

Also, remember to pat yourself on the back after the commit, smile and think we're a step closer to a better ircd/services.