https://github.com/psu-libraries/guides
Guides for writing code.
https://github.com/psu-libraries/guides
Last synced: 3 months ago
JSON representation
Guides for writing code.
- Host: GitHub
- URL: https://github.com/psu-libraries/guides
- Owner: psu-libraries
- License: apache-2.0
- Created: 2017-07-21T14:59:01.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2021-04-09T14:35:45.000Z (over 5 years ago)
- Last Synced: 2025-01-17T07:45:22.984Z (over 1 year ago)
- Language: Ruby
- Size: 54.7 KB
- Stars: 1
- Watchers: 12
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Guides
Guides for getting things done, programming well, and programming in style.
* [Style](style)
Fundamentals:
* No feigning surprise
* No well-actually's
* No back-seat driving
* No subtle-isms
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.
## Contributing
Please open an issue or submit a pull request!
## Credits
Inspired by [thoughtbot, inc](https://thoughtbot.com). The overall layout and initial coding style decisions
are copied (not forked!) from [their guide](https://github.com/thoughtbot/guides) and then
adjusted to meet our agreed-upon conventions.
## License
These guides are available under the Apache 2.0 license.
[Read the copyright statement and license](LICENSE.md).