coding-standards.md

The Programming Best Practices Tidbits has a lot of fantastic guidelines for writing code that are mostly language agnostic.

General

• From Piper [aaronmerriam]:
  • It it is not in source control, it does not exist.
    • To work collaboratively with others you must use version control. See the following reasons.
  • It must be tested.
    • If the code you write is not tested, there is no reasonable way to collaborate without knowing whether what you are doing has broken something, or whether or not it worked at all in the first place.
    • I suggest using Travis CI. You can see this in practice in the ladder application.
  • Write maintainable code.
    • Your code should have useful comments and documentation.
    • Don't be clever. If you are writing the cleverest code you can, you won't be able do debug it later.
  • Use an editor that shows you syntax errors.
  • Make good commits.
  • Use pull requests
    • Pull requests are a great way to organize your code and let others know what you are working on.

Python

• Adhere to pep8
• The zen of python.

JavaScript

• Use a framework.

PHP