https://github.com/cesium/guides
📐 Guides for programming in style
https://github.com/cesium/guides
guidelines styleguide
Last synced: 6 months ago
JSON representation
📐 Guides for programming in style
- Host: GitHub
- URL: https://github.com/cesium/guides
- Owner: cesium
- Created: 2022-01-15T15:18:52.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-27T14:26:47.000Z (over 3 years ago)
- Last Synced: 2025-04-06T11:49:11.061Z (over 1 year ago)
- Topics: guidelines, styleguide
- Homepage:
- Size: 1.18 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[contributors]: https://github.com/cesium/guides/graphs/contributors
[thoughtbot]: https://thoughtbot.com/
[license]: https://creativecommons.org/licenses/by/4.0
# Guides
A set of patterns and standards to complement the rules and presets for the
linting and formatting tools used in our projects.
The aim is to facilitate working together by following good practices that
everyone can agree on.
### High level guidelines
- Be consistent.
- Don't rewrite existing code to follow this guide.
- Don't violate a guideline without a good reason.
- A reason is good when you can convince a teammate.
### 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.
## ✨ Credits
Thank you, [contributors][contributors]!
Thanks to [thoughtbot][thoughtbot] from whom these guides are
[based](https://github.com/thoughtbot/guides).
## 📝 License
These guides are © 2022 CeSIUM. They are distributed under the [Creative
Commons Attribution 4.0 International License][license].