If you have any questions contact @nuest.
- Speaking method names and understandable class names are the minumum documnetation, and can actually suffice for documentation.
- Comment code in English
- Write commit messages in present tense - for the repo the thing did not happen before you write your message but only when the commit happens.
- Use descriptive messages, not "update to code", or "bugfix".
- Add references to task numbers or issue trackers with more information.
- Divide and conquer - if you have to scroll to see a complete method/self-contained piece of code, then split it up.
- Use a common code formatter in your group.
- Follow naming conventions.
- Use logging frameworks.
- Read books about programming.
- http://agilemanifesto.org/
- https://twitter.com/codewisdom
- https://wiki.52north.org/bin/view/Documentation/TipsForBetterCoding
- Liskov substitution principle > http://en.wikipedia.org/wiki/Liskov_substitution_principle
- SOLID (object-oriented design) > http://en.wikipedia.org/wiki/Solid_%28object-oriented_design%29
- TBL's principles of design > http://www.w3.org/DesignIssues/Principles.html
- http://blog.codinghorror.com/the-best-code-is-no-code-at-all/
- XKCD: How to write good code > http://xkcd.com/844/
- http://nordholmen.net/programming/
- http://en.wikipedia.org/wiki/Best_Coding_Practices
- Each member of the group must have his/her own fork of code.
- Each member of the group must send at least one pull request and merge another persons pull request.
- Discuss and document your discussions in a comprehensible manner.