https://github.com/codeclimate/styleguide
Code Climate's Internal Style Guides
https://github.com/codeclimate/styleguide
Last synced: 9 months ago
JSON representation
Code Climate's Internal Style Guides
- Host: GitHub
- URL: https://github.com/codeclimate/styleguide
- Owner: codeclimate
- Created: 2015-04-29T13:01:46.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-07-25T23:01:50.000Z (over 1 year ago)
- Last Synced: 2024-07-27T01:08:53.768Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://brand.codeclimate.net
- Size: 89.8 KB
- Stars: 23
- Watchers: 21
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Code Climate Style Guides
A consistent style is important in a code base. Inconsistency greatly increases
the number of inconsequential decisions developers must make. Consistency is
good for readability and a clean code base promotes keeping a code base clean
(i.e. Broken Window Theory). It is more important, and ultimately will make you
happier, to abide by a defined style and end up in a consistent code base, than
to code in your own preferred style and not.
Any PR comments regarding violations of the guidelines here should be addressed
immediately and without discussion. If you disagree with a guideline, propose a
change in a PR to this repo. Once the team has settled on a guideline, it must
be followed.
Existing code may be fixed for style if, and only if, it must be touched in the
course of your current work. Do not change code *only* to fix style.
## Terminology
- **Do**, **don't**, etc: these must be followed always
- **Avoid**/**prefer**: if not following these, the burden is on you to convince
your reviewer why
## Guides
This repository includes written guides & relevant linter configuration for the
following languages:
- [Haskell](haskell/README.md)
- [HTML](html/README.md)
- [JavaScript](javascript/README.md)
- [Ruby](ruby/README.md)
- [Sass](sass/README.md)