https://github.com/marella/guides

General contributing guidelines and coding standards.
https://github.com/marella/guides

Last synced: about 1 year ago
JSON representation

General contributing guidelines and coding standards.

• Host: GitHub
• URL: https://github.com/marella/guides
• Owner: marella
• Created: 2016-03-04T06:40:50.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2016-08-25T05:17:26.000Z (almost 10 years ago)
• Last Synced: 2025-03-31T07:42:19.814Z (about 1 year ago)
• Homepage:
• Size: 6.84 KB
• Stars: 1
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Guides

Guides for getting things done, programming well, and programming in style.

> Every line of code should appear to be written by a single person, no matter the number of contributors.

- [General](/general)

- [Git](/git)

- [PHP](/php)

High level guidelines:

- Be consistent

- Don't violate a guideline without a good reason

- A reason is good when you can convince a teammate

- When a new guideline is introduced, don't rewrite existing code to follow it

- When a change in a guideline breaks an existing one or requires lot of code changes, it should be followed only in the next version of software

- If a guideline conflicts with other existing guides then treat the one in this guide as final

A note on the language:

- "Avoid" means don't do it unless you have good reason

- "Don't" means there's never a good reason

- "Prefer" indicates a better option and its alternative to watch out for

- "Use" is a positive instruction

- "Always" indicates the best option

## Further Reading

- https://github.com/thoughtbot/guides