Skip to content

A repo for documenting standards for writing code.

License

Notifications You must be signed in to change notification settings

irabudev/styleguide

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

A Style Guide

This is a project for documenting standards for writing code.

Part of being a good steward to a successful project is realizing that writing code for yourself is a Bad Idea™. If thousands of people are using your code, then write your code for maximum clarity, not your personal preference of how to get clever within the spec. - Idan Gazit

Generally

ProTip All code in any code-base should look like a single person typed it, even when many people are contributing to it.

  • Don't try to prematurely optimize your code; keep it readable and understandable.
  • Strictly enforce the agreed-upon style.
  • If in doubt when deciding upon a style use existing, common patterns.

Whitespace

ProTip Only one style should exist across the entire source of your code-base.

  • Use whitespace to improve readability.
  • Always be consistent in your use of whitespace.

Indentation

ProTip Use an EditorConfig file (or equivalent) to help maintain the basic agreed conventions. ProTip Configure your editor to "show invisibles" and/or to automatically remove end-of-line whitespace.

  • Never mix spaces and tabs for indentation.
  • Choose between spaces or tabs. Stick to your choice without fail.

More Guidelines

  1. Git guidelines
  2. PHP guidelines

TODOs

For a list of active/queued tasks, please be sure to read the TODO.

Contributing

Before making a pull request, please be sure to read the Contributing Guide.

Changelog

For a list of all notable changes, please be sure to read the Changelog.

Acknowlegements

CSS

Git

PHP

Contacts

Feel free to yell at me: mabinajoshua@gmail.com