Skip to content
This repository was archived by the owner on Aug 16, 2024. It is now read-only.

scholarslab/programming_guides

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Guides

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

High Level Guidelines

  • Be consistent.
  • Don't rewrite code to follow this guide.
  • Don't violoate a guideline without a good reason.
  • A reason is good when you can convince a teammate.

A note the the language:

  • "Avoid" means don't do it unless you have a 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.

Contributing

Please read the contribution guidelines before submitting a pull request.

In particular: if you have commit access, please don't merge changes without waiting a week for everybody to leave feedback.

License

Portions of this guide are based on Guides. Like Guides, this is distributed under the Creative Commons Attribution License.

About

A guide for programming style.

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published