Skip to content

bcope/style_guides

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Style Guides

Principles

  • Justified
    • All style choices should cite a reason for the choice
  • Best practices
    • Style choices should not veer from broadly accepted best practices without a very good reason
  • Version controlled first
    • Style choices should enable cleaner, easier reviews of file diffs
  • Consistency across languages
    • When possible and sensible similar styles should be adopted across languages

Guides

Contribute

  1. Fork this repo
  2. Make edits in the main branch
  3. Follow the guidance in the markdown style guide
    1. If you add a new guide then add it to the list above
  4. Create a PR with your changes
    1. Your PR should contain a justification for each change that you're making

About

A repo to store the styles I've adopted and decisions I've made so I don't need to re-litigate these choices in my own head each time.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors