This repository has been archived by the owner. It is now read-only.
No matter how complex the processes or magical the output is, ultimately, it can and should be reduced to a set of rules, for continuity sake
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
best-practice
code-review
convention
style
LICENSE
README.md

README.md

M.O.

Modus Operandi.

No matter how complex the processes or magical the output is, ultimately, it can and should be reduced to a set of rules, for continuity sake. These are guidelines/recommendations for getting things done in a collaborative/community environment and programming in style.

Guidelines

  • Best Practice - techniques that have consistently shown results
  • Code Review - how to examine each others code
  • Convention - that which is considered acceptable or polite to most
  • Style - easy to read and good to look at

The Top Layer

  • Be consistent.
  • Teach, if you can.
  • Publish what you learn.
  • Many heads are inevitably better than one.
  • Don't violate a guideline without a good reason.
  • A reason is good when you can convince a teammate.
  • Don't rewrite existing code to follow the code guidelines.
  • Code well. Everyone leaves. Your last duty should be to hand it off to a competent successor.
  • Don't wait for crisis to change, adopt an M.O. asap and stay safe.

Language

  • "Avoid" means don't do it unless you have good reason.
  • "Don't" means there's never a good reason.
  • "Prefer" indicates there's a better option, you can evaluate it's pros and cons.
  • "Use" is a positive instruction.
  • "Limit" is a caution against excesses.
  • "Team" comprises a group of people linked in a common purpose.
  • Lack of "Avoid", "Don't", "Prefer", "Use" or "Limit" implies a rule.

Credits

Direct and indirect influences:

License

King'ori J. Maina © 2013. The MIT License bundled therein is a permissive license that is short and to the point. It lets people do anything they want as long as they provide attribution and waive liability.