Code Standards and Resources

Code-Standards.md

Code Standards

Here are some resources to help us write better code and recognize code that may need some help.

HTML

• Semantic HTML (best practices)
  • http://www.smashingmagazine.com/2011/11/18/html5-semantics
  • http://boagworld.com/dev/semantic-code-what-why-how
  • http://alistapart.com/article/semanticsinhtml5
  • http://alistapart.com/article/unwebbable
• Accessibility
  • https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA
  • http://alistapart.com/article/htmlkills
  • http://alistapart.com/article/prettyaccessibleforms
  • http://alistapart.com/article/wiwa/

CSS

• Best Practices
  • https://developer.mozilla.org/en-US/docs/Web/Guide/CSS/Writing_efficient_CSS
• Object Oriented CSS
  • http://www.smashingmagazine.com/2011/12/12/an-introduction-to-object-oriented-css-oocss
  • http://appendto.com/2014/04/oocss/

Python

JavaScript/ECMA5

• Best Practices

  • http://jstherightway.org
  • http://modernweb.com/2013/12/23/45-useful-javascript-tips-tricks-and-best-practices
  • http://alistapart.com/article/writing-testable-javascript
  • http://alistapart.com/article/the-design-of-code-organizing-javascript

• Resources

  • https://developer.mozilla.org/en-US/docs/Web/JavaScript
  • http://lab.abhinayrathore.com/jquery-standards
  • https://www.codeschool.com/courses/javascript-best-practices

Database Architecture

• Best Practices
  • http://c2.com/cgi/wiki?DatabaseBestPractices
  • http://en.wikipedia.org/wiki/Database_normalization
  • http://architects.dzone.com/articles/20-database-design-best
  • https://www.simple-talk.com/sql/database-administration/ten-common-database-design-mistakes
  • http://agiledata.org/essays/bestPractices.html
  • http://digitalethos.org/relational-database-design-a-best-practices-primer

In a Nutshell

• HTML will be sematic
• HTML will be accessible
• Disabling Javascript should not render page inoperable
• Flash is obsolete and not a solution of anykind
• CSS will be minified
• CSS will not be inline
• Javascript will be minified
• Python will be PEP8
• Database Schemas will be normalized
• There will be no "SELECT *"'s
• There will be no direct access from HTTP variables i.e. "SELECT something from mytable where id = " + request.get('submitted_id')

Principles to successfully accomplish our goals

• Automate Everything (Like Github says). We can use git hooks and pre-deployment scripts to check code standards and run tests.
• p2p Accountability. Be open and honest! If you see something in some code talk to the person that committed it and fix it together! While smiling, laughing and shooting eachother with nerf darts.
• Teach Others! If you know something you think is cool then make a presentation on it and share!