Style guides
All code should adopt the language specific style guide linked here. However, consistent code style within a repository codebase is preferable to piecemeal adoption of a standard. If your project has not yet adopted a standard style, reserve some technical debt time to apply the style across all the codebase in one pass.
Google style guides
These languages adopt Google Style Guides
- HTML/CSS https://google.github.io/styleguide/htmlcssguide.html>
- Java https://google.github.io/styleguide/javaguide.html
- Javascript https://google.github.io/styleguide/jsguide.html
- Python https://google.github.io/styleguide/pyguide.html
- Shell (bash) https://google.github.io/styleguide/shell.xml
- R https://google.github.io/styleguide/Rguide.html
- Ruby https://github.com/rubocop-hq/ruby-style-guide
IDE support
Google also maintain a set of IDE configuration files to apply styles with minimal effort for a variety of IDEs.
You can find these at the Google styleguide repository on Github
NHSBSA style guides
These languages adopt NHSBSA internally defined Style Guides
- Shell (korn) TODO by Applications Operations team
- PL/SQL https://bsa2468.atlassian.net/wiki/spaces/IHP/pages/44704932/PLSQL+Coding+Standards
References
Improve the playbook
If you spot anything factually incorrect with this page or have ideas for improvement, please share your suggestions.
Before you start, you will need a GitHub account. Github is an open forum where we collect feedback.
Published: