Development Team/Commit Guidelines

Current revision as of 19:01, 28 July 2011

DareNET Development Wiki - Development Team/Commit Guidelines

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. Please follow the format being currently used.
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 documentation, it may well be wrong. Test the behavior or ask.
Don't be afraid of having your changes reviewed. Routinely check the 'Code Reviews' page on the tracker.
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 what you're committing. Make sure you're only committing what you need. Do a hg diff of the files you're going to commit and check the changes.
Make sure you don't change line endings and white space.
Don't do reformatting commits, unless you're the original author of the code.
NEVER remove copyright notices from the code.
NEVER remove licensing info from the code.
Never commit code you didn't write yourself or that doesn't have a suitable license. Upstream merges/syncs should credit the actual author of the code.
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.

Current ChangeLog Format

YYYY-MM-DD    Nickname/Name    <your@email.com>

  * filename (function_name): meaingful explanation of change.

  * repeat

@@ Line 1: / Line 1: @@
-Once you have commit access, there are a few other small rules to follow:
+{{Header|1 = <h2>'''[[Development Team|DareNET Development Wiki]]''' - {{FULLPAGENAME}}</h2>}}
+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.
+* ALWAYS add a ChangeLog entry with a meaningful explanation. Please follow the format being currently used.
-* If you fix a bug, please add a regression test for it in the test suite.
+* If you fix a bug, we ask that you also add a [http://en.wikipedia.org/wiki/Regression_testing regression test] for it in the test suite.
+* When fixing bugs, don't blindly follow documentation, it may well be wrong. Test the behavior or ask.
+* Don't be afraid of having your changes reviewed. Routinely check the 'Code Reviews' page on the [http://redmine.darenet.org tracker].
+* 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 what you're committing: make sure you're only committing what you need and make sure you don't change line endings and whitespace. Do a svn diff of the files you're going to commit and check the changes.
+* Always check what you're committing. Make sure you're only committing what you need. Do a <code>''hg diff''</code> of the files you're going to commit and check the changes.
+* Make sure you don't change line endings and white space.
 * Don't do reformatting commits, unless you're the original author of the code.
-* When fixing bugs, don't follow the documentation blindly, 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.
+* NEVER remove copyright notices from the code.
-* Never remove copyright notices from the code.
+* NEVER remove licensing info from the code.
-* Never remove licensing info from code.
+* Never commit code you didn't write yourself or that doesn't have a suitable license. Upstream merges/syncs should credit the actual author of the code.
-* Never commit code you didn't write yourself or code that doesn't have a suitable license.
 * Follow the coding guidelines.
-* Do a regression test run if making changes to core functionality before committing.
 Also, remember to pat yourself on the back after the commit, smile and think we're a step closer to a better ircd/services.
+== Current ChangeLog Format ==
+<pre>
+YYYY-MM-DD    Nickname/Name    <your@email.com>
+  * filename (function_name): meaingful explanation of change.
+  * repeat
+</pre>