-
Notifications
You must be signed in to change notification settings - Fork 0
Code Standards
Eric Stout edited this page Apr 12, 2018
·
7 revisions
We write code in a consistent style that emphasizes cleanliness and team communication.
Some of our high level guidelines:
- Be consistent.
- Don't violate a guideline without a good reason. (A reason is good when you can convince a teammate)
- Always use Semantic Markup
- Approach the document with practicality over purity
- Prefer double quotes for attributes.
- Consistency and conventions between team members is paramount.
- Solutions should be as simple and clear as possible.
- Solutions should serve a specific purpose.
- Clever code does not mean good code; readability is critical
- Nested lists MUST NOT be more than 3 levels deep
- HTML attributes should come in this particular order for easier reading of code.
- id, name
- class
- src, for, type, href, value
- data-*
- title, alt
- role, aria-*
Feel free to open an issue if you find mistakes, enhancements, or would like to see some new documentation.