https://github.com/sdslabs/styleguide
Internal coding styleguide for SDSLabs.
https://github.com/sdslabs/styleguide
Last synced: 3 months ago
JSON representation
Internal coding styleguide for SDSLabs.
- Host: GitHub
- URL: https://github.com/sdslabs/styleguide
- Owner: sdslabs
- Created: 2012-12-28T20:09:41.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2020-04-11T13:35:37.000Z (about 6 years ago)
- Last Synced: 2025-02-23T20:32:00.969Z (over 1 year ago)
- Homepage: blog.sdslabs.co/styleguide
- Size: 263 KB
- Stars: 12
- Watchers: 36
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SDSLabs Code Styleguide
## Write Consistent Code
If you're editing code, take a few minutes to look at the code around you and determine its style. If they use spaces around all their arithmetic operators, you should too. If their comments have little boxes of hash marks around them, make your comments have little boxes of hash marks around them too.
The point of having style guidelines is to have a common vocabulary of coding so people can concentrate on what you're saying rather than on how you're saying it. We present global style rules here so people know the vocabulary, but local style is also important. If code you add to a file looks drastically different from the existing code around it, it throws readers out of their rhythm when they go to read it. Avoid this.
## Variations
You will see our directory structure goes `guides//v.md`. This is to maintain multiple variations of styles used inside SDSLabs. Needless to say, the `v` in `v*.md` stands for 'variation'.
---
Created by SDSLabs