# Technical Documentation: Kristories/awesome-guidelines

> ℹ️ **Provenance:** Multi-Tier Ingestion · [CodeWiki Reference](https://codewiki.google/github.com/Kristories/awesome-guidelines)

### Overview (`README.md`)

# Awesome Guidelines [](https://awesome.re)

Programming style, best practices, and coding conventions.

## Contents

- [Programming Languages](#programming-languages)
- [Development Environment](#development-environment)
- [Platforms](#platforms)
- [Frameworks](#frameworks)
- [Content Management System](#content-management-system)
- [Tools](#tools)

## Programming Languages

### Ada

- [Ada Programming/Coding standards](https://en.wikibooks.org/wiki/Ada_Programming/Coding_standards) - Suggestions of Ada programming guidelines

### Brainfuck

- [BF Style Guide](https://codepen.io/renmans/full/JjdJPpW) - Guidelines for writing and formatting Brainfuck code.

### C

- [C Coding Standard](https://users.ece.cmu.edu/~eno/coding/CCodingStandard.html) - Conventions and best practices for C code.
- [C Programming/Structure and style](https://en.wikibooks.org/wiki/C_Programming/Structure_and_style) - Structural and style recommendations for C programs.
- [Making The Best Use of C](https://www.gnu.org/prep/standards/html_node/Writing-C.html) - This chapter provides advice on how best to use the C language when writing GNU software.

### C#

- [C# Coding Conventions](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions) - Official C# coding style conventions.
- [C# Style Guide](https://github.com/kodecocodes/c-sharp-style-guide) - Community C# style guide.
- [C# Coding Standards and Naming Conventions](http://www.dofactory.com/reference/csharp-coding-standards) - Standards and naming conventions for C# code.

### C++

- [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html) - C++ coding standards and best practices.
- [C++ Core Guidelines](http://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines) - A set of tried-and-true guidelines, rules, and best practices about coding in C++.
- [LLVM C++ Coding Standards](https://llvm.org/docs/CodingStandards.html) - Coding standards for the LLVM project.
- [Mozilla C++ Coding style](https://firefox-source-docs.mozilla.org/code-quality/coding-style/coding_style_cpp.html) - C++ coding style guidelines for Mozilla codebases.
- [Chromium C++ style guide](https://chromium.googlesource.com/chromium/src/+/HEAD/styleguide/c++/c++.md) - C++ style guide for the Chromium project.
- [Webkit C++ Code Style Guidelines](https://webkit.org/code-style-guidelines/) - C++ code style guidelines for WebKit.
- [NASA C++ Coding Standards and Style Guide](https://ntrs.nasa.gov/api/citations/20080039927/downloads/20080039927.pdf) - C++ coding standards for safety-critical systems.
- [OceanBase C++ Coding Standards](https://oceanbase.github.io/oceanbase/coding_standard.html) - C++ coding standards for OceanBase.

### Clojure

- [The Clojure Style Guide](https://github.com/bbatsov/clojure-style-guide) - A community coding style guide for the Clojure programming language.

### Common Lisp

- [Style Guide](http://lisp-lang.org/style-guide/)
- [Google Common Lisp Style Guide](https://google.github.io/styleguide/lispguide.xml)

### D

- [The D Style](https://dlang.org/dstyle.html) - A set of style conventions for writing D programs.

### Dart

- [Effective Dart](https://dart.dev/effective-dart) - Recommendations for consistent, idiomatic Dart code.

### Delphi

- [Delphi's Object Pascal Style Guide](https://docwiki.embarcadero.com/RADStudio/Alexandria/en/Delphi%E2%80%99s_Object_Pascal_Style_Guide) - Object Pascal coding style guidelines.

### Elixir

- [Elixir Styleguide](https://github.com/christopheradams/elixir_style_guide) - Community Elixir coding style guide.

### Elm

- [Elm style guide](http://elm-lang.org/docs/style-guide) - Style suggestions and conventions for Elm.

### Emacs Lisp

- [Elisp Guide](https://github.com/chrisdone/elisp-guide) - Guide to writing Emacs Lisp.
- [Emacs Lisp Style Guide](https://github.com/bbatsov/emacs-lisp-style-guide) - Community style guide for Emacs Lisp.

### Erlang

- [Secure Coding Guidelines](https://www.erlang.org/doc/system/secure_coding.html) - Writing secure Erlang code, describing common pitfalls and weaknesses best avoided.
- [Erlang Coding Guidelines](https://github.com/inaka/erlang_guidelines)

### F#

- [The F# Component Design Guidelines](https://learn.microsoft.com/en-us/dotnet/fsharp/style-guide/component-design-guidelines) - Official design and style guidelines for F#.

### Fortran

- [Fortran Best Practices](https://fortran-lang.org/en/learn/best_practices/) - Style guide and best practices for modern Fortran programs.

### Go

- [Effective Go](https://go.dev/doc/effective_go) - Idioms and best practices for Go.
- [Go Standard Project Layout](https://github.com/golang-standards/project-layout) - Basic layout for Go applications.
- [Google Go Style Guide](https://google.github.io/styleguide/go) - Google's coding standards for source code in Go.
- [Uber Go Style Guide](https://github.com/uber-go/guide/blob/master/style.md) - Patterns and conventions used in Go code at Uber.

### Groovy

- [Apache Groovy style guide](http://groovy-lang.org/style-guide.html) - Style guide for writing idiomatic Groovy code.

### Haskell

- [Haskell Programming guidelines](https://wiki.haskell.org/Programming_guidelines) - Best practices for Haskell programming.

### Java

- [Code Conventions for the Java™ Programming Language](http://www.oracle.com/technetwork/java/codeconvtoc-136057.html) - Historical Java coding conventions.
- [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html) - Google's coding standards for source code in the Java™ Programming Language.
- [Java Programming Style Guide](https://coderanch.com/wiki/718799/Style)
- [Alibaba-Java-Coding-Guidelines](https://alibaba.github.io/Alibaba-Java-Coding-Guidelines/) - A guide for Java developers.

### JavaScript

- [AngularJS Style Guide](https://github.com/mgechev/angularjs-style-guide) - Community-driven set of best practices for AngularJS application development.
- [JavaScript The Right Way](http://jstherightway.org) - An easy-to-read, quick reference for JS best practices, accepted coding standards, and links around the Web.
- [Google JavaScript Style Guide](https://google.github.io/styleguide/jsguide.html) - This document serves as the complete definition of Google's coding standards for source code in the JavaScript programming language.
- [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript) - A mostly reasonable approach to JavaScript.
- [jQuery Core Style Guide](http://contribute.jquery.org/style-guide/js/) - JavaScript style rules for open-source contributors.
- [JavaScript Style Guides And Beautifiers](https://addyosmani.com/blog/javascript-style-guides-and-beautifiers/) - Roundup of JavaScript style guides and formatting tools.
- [JavaScript Style Guide and Coding Conventions](https://www.w3schools.com/js/js_conventions.asp) - General JavaScript coding conventions and best practices.
- [Code Conventions for the JavaScript](https://www.crockford.com/code.html) - A set of coding conventions and rules for use in JavaScript programming.
- [JavaScript Clean Code](https://github.com/ryanmcdermott/clean-code-javascript) - Software engineering principles, from Robert C. Martin's book [Clean Code](https://www.amazon.com/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882), adapted for JavaScript.
- [Mozilla Coding Style Guide for JavaScript](https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Writing_style_guide/Code_style_guide/JavaScript)

### JSON

- [Google JSON Style Guide](https://google.github.io/styleguide/jsoncstyleguide.xml) - Recommendations for JSON formatting and usage.

### Julia

- [Blue Style](https://github.com/JuliaDiff/BlueStyle) - Community style guide for Julia packages.

### Kotlin

- [Coding Conventions](https://kotlinlang.org/docs/coding-conventions.html) - Official Kotlin coding conventions.

### Lua

- [Lua Style Guide](http://lua-users.org/wiki/LuaStyleGuide) - Community Lua coding style guide.

### Markdown

- [Google Markdown Style Guide](https://github.com/google/styleguide/blob/gh-pages/docguide/style.md) - Style guide for Google-originated projects using Markdown.
- [Markdown Style Guide](http://www.cirosantilli.com/markdown-style-guide/) - Practical guidelines for writing readable Markdown.
- [GitLab Markdown Style Guide](https://about.gitlab.com/handbook/markdown-guide/) - Markdown Style Guide for about.GitLab.com.

### .NET

- [.NET Standard](https://github.com/dotnet/standard) - Formal specification of .NET APIs that are available across .NET implementations.
- [.NET Secure Coding Guidelines](https://learn.microsoft.com/en-us/dotnet/standard/security/secure-coding-guidelines) - Guidance for writing secure .NET code.
- [.NET Naming Guidelines](https://learn.microsoft.com/en-us/dotnet/standard/design-guidelines/naming-guidelines) - Naming conventions for .NET libraries.

### Nim

- [Nim Style Guide](https://nim-lang.org/docs/nep1.html) - Style conventions and RFC for Nim code.

### Objective-C

- [Objective-C Style guide](https://github.com/github/objective-c-style-guide) - Style guide & coding conventions for Objective-C projects.
- [Google Objective-C Style Guide](https://github.com/google/styleguide/blob/gh-pages/objcguide.md) - Objective-C coding standards and conventions.
- [NYTimes Objective-C Style Guide](https://github.com/NYTimes/objective-c-style-guide) - The Objective-C Style Guide used by The New York Times.

### Pascal

- [Coding style](http://wiki.freepascal.org/Coding_style) - Style recommendations for Free Pascal.
- [GNU Pascal Coding Standards](https://edoras.sdsu.edu/doc/gpcs-en.html) - GNU Pascal standards used by GNU Pascal project.

### Perl

- [Perl best practices v4](https://www.slideshare.net/RandalSchwartz/perl-best-practices-v4) - Slides by Randal Schwartz, based on the book by Damian Conway.
- [Perl Elements to Avoid](http://perl-begin.org/tutorials/bad-elements/) - A list of unrecommended practices, and what to do instead.
- [perlstyle](https://perldoc.perl.org/perlstyle) - Perl style guidelines.

### PHP

- [PHP FIG](http://www.php-fig.org/psr/) - PHP Standards Recommendations.
- [PHP The Right Way](http://www.phptherightway.com) - An easy-to-read, quick reference for PHP best practices, accepted coding standards, and links to authoritative tutorials around the Web.
- [Clean Code PHP](https://github.com/piotrplenik/clean-code-php) - Clean Code concepts adapted for PHP.

### Python

- [Style Guide for Python Code](https://peps.python.org/pep-0008/) - Official Python style guide (PEP 8).
- [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html) - Python coding standards.
- [The Hitchhiker's Guide to Python](https://docs.python-guide.org/) - Highly regarded Python best practices guide.

### R

- [Google's R Style Guide](https://google.github.io/styleguide/Rguide.html) - R style conventions.
- [The tidyverse style guide](http://style.tidyverse.org) - Style guide for R code in the tidyverse.

### Racket

- [How to Program Racket: a Style Guide](http://docs.racket-lang.org/style/index.html) - Style guidance for Racket programs.

### Ruby

- [The Ruby Style Guide](https://rubystyle.guide) - A community-driven Ruby coding style guide.
- [Ruby Style Guide](https://github.com/airbnb/ruby) - Airbnb's Ruby Style Guide.
- [Ruby Style Guide](https://github.com/rubocop/ruby-style-guide) - A community-driven Ruby coding style guide.

### Rust

- [Rust Style Guide](https://github.com/rust-lang/rust/tree/HEAD/src/doc/style-guide/src)
- [Rust API Guidelines](https://rust-lang.github.io/api-guidelines/) - Guidelines for designing public Rust APIs.

### Scala

- [Effective Scala](https://twitter.github.io/effectivescala/) - Best practices and patterns for Scala.
- [Scala Style Guide](http://docs.scala-lang.org/style/) - Official style guide for Scala code.
- [Databricks Scala Guide](https://github.com/databricks/scala-style-guide) - Databricks Scala Coding Style Guide.
- [Scala Best Practices](https://github.com/alexandru/scala-best-practices) - Recommendations and patterns for Scala development.

### Solidity

- [Solidity Style Guide](https://docs.soliditylang.org/en/latest/style-guide.html) - Style guidelines for Solidity smart contracts.
- [Solcurity Standard](https://github.com/transmissions11/solcurity) - Security checklist and guidelines for Solidity smart contracts.

### Swift

- [API Design Guidelines](https://www.swift.org/documentation/api-design-guidelines/) - API design principles for Swift.
- [Swift](https://github.com/github/swift-style-guide) - GitHub Official Swift style and conventions.
- [Swift style guide](https://github.com/kodecocodes/swift-style-guide) - Community Swift style guide.
- [Swift Style Guide](https://github.com/linkedin/swift-style-guide) - LinkedIn Official Swift Style Guide.
- [Metova's Swift style guide](https://github.com/metova/swift-style-guide) - Swift style guide for Xcode (archived, deprecated 2022).
- [Xmartlabs Swift Style Guide](https://github.com/xmartlabs/Swift-Style-Guide) - Swift language style guide & coding conventions followed by Xmartlabs.

### TypeScript

- [Google TypeScript Style Guide](https://google.github.io/styleguide/tsguide.html) - TypeScript Style Guide used at Google's.
- [TypeScript deep dive - Style Guide](https://basarat.gitbook.io/typescript/styleguide) - An unofficial TypeScript Style Guide.
- [TypeScript Lang - Do's and Don'ts](https://www.typescriptlang.org/docs/handbook/declaration-files/do-s-and-don-ts.html) - Suggestions from TypeScript Lang organization.

### Visual Basic

- [Visual Basic Concepts](<https://msdn.microsoft.com/en-us/library/aa240822(v=vs.60).aspx>) - Concepts and coding practices for classic Visual Basic.
- [Visual Basic/Coding Standards](https://en.wikibooks.org/wiki/Visual_Basic/Coding_Standards) - Coding standards for Visual Basic projects.

### XML

- [Google XML Document Format Style Guide](https://google.github.io/styleguide/xmlstyle.html) - XML formatting and style guidance.

## Development Environment

### Shell

- [Shell Style Guide](https://google.github.io/styleguide/shellguide.html) - Shell script style guide.

### Git

- [Git Style Guide](https://github.com/agis/git-style-guide) - Git usage and style recommendations.
- [Few Rules from Git Documentation](https://github.com/git/git/blob/master/Documentation/CodingGuidelines) - Coding guidelines used in the Git project.

### PowerShell

- [The PowerShell Best Practices and Style Guide](https://github.com/PoshCode/PowerShellPracticeAndStyle) - The Unofficial PowerShell Best Practices and Style Guide.

## Platforms

### Android

- [Android Guidelines](https://github.com/ribot/android-guidelines) - Architecture and code guidelines we use at ribot when developing for Android.
- [Xmartlabs Android Style Guide](https://github.com/xmartlabs/Android-Style-Guide) - Style guide for Android by Xmartlabs.

### Apache

- [Apache Developers' C Language Style Guide](http://httpd.apache.org/dev/styleguide.html) - C language style guidelines for the Apache HTTP Server project.

### API

- [HAL](http://stateless.co/hal_specification.html) - A simple format that gives a consistent and easy way to hyperlink between resources in your API.
- [Microsoft REST API Guidelines](https://github.com/Microsoft/api-guidelines) - The Microsoft REST API Guidelines.
- [JSON API - Recommendations](http://jsonapi.org/recommendations) - This section contains recommendations for JSON API implementations.
- [API Security Checklist](https://github.com/shieldfy/API-Security-Checklist) - Checklist of the most important security countermeasures when designing, testing, and releasing your API.
- [Google Cloud API Design Guide](https://cloud.google.com/apis/design) - A general design guide for networked APIs provided by Google.

### Arduino

- [Arduino style guide](https://www.arduino.cc/) - General coding style guidance for Arduino.
- [API Style Guide for Arduino](https://docs.arduino.cc/learn/contributions/arduino-library-style-guide/)

### Frontend Development

- [CSS Guidelines](https://cssguidelin.es) - High-level advice and guidelines for writing sane, manageable, scalable CSS.
- [Frontend Guidelines](https://github.com/bendc/frontend-guidelines) - Some HTML, CSS and JS best practices.
- [Sass Guidelines](https://sass-guidelin.es) - An opinionated styleguide for writing sane, maintainable and scalable Sass.
- [Airbnb CSS / Sass Styleguide](https://github.com/airbnb/css) - A mostly reasonable approach to CSS and Sass.
- [HTML Style Guide](https://github.com/marcobiedermann/html-style-guide) - A style guide which helps you write better, performant, structured, scalable and maintainable HTML.
- [HTML + CSS Code Guide](http://codeguide.co) - Standards for flexible, durable, and sustainable HTML and CSS.
- [U.S. Web Design Standards](https://designsystem.digital.gov/) - Open source UI components and visual style guide for U.S. government websites.
- [CoffeeScript Style Guide](https://github.com/polarmobile/coffeescript-style-guide) - A collection of best-practices and coding conventions for the CoffeeScript programming language.
- [LESS Coding Guidelines](https://gist.github.com/fat/a47b882eb5f84293c4ed)
- [Google HTML/CSS Style Guide](https://google.github.io/styleguide/htmlcssguide.html)
- [Guidelines for Responsive Web Design](https://www.smashingmagazine.com/2011/01/guidelines-for-responsive-web-design/) - Guide to designing for screen size, platform, and orientation.
- [Yelp Styleguide](https://www.yelp.com/styleguide) - Design system for consistent product UI.
- [Front-End Checklist](https://github.com/thedaviddias/Front-End-Checklist) - Pre-launch checklist for front-end projects.
- [BEM - Block Element Modifier](https://getbem.com/) - A methodology that helps you to create reusable components and code sharing in front‑end development.
- [Web Content Accessibility Guidelines (WCAG) 2.1](https://www.w3.org/TR/WCAG21/) - Recommendations for making web content more accessible.  
### GNU

- [GNU coding standards](https://www.gnu.org/prep/standards/) - Coding and documentation standards for GNU software.

### Java

- [JavaEE Specification](https://github.com/javaee/javaee-spec) - Official specification for Java EE.

### Linux

- [Linux kernel coding style](https://www.kernel.org/doc/html/latest/process/coding-style.html) - Coding style for the Linux kernel.

### Mailchimp

- [Mailchimp Content Style Guide](https://styleguide.mailchimp.com) - Content style guidelines for Mailchimp.

### Mozilla

- [Mozilla Coding Style Guide](https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Writing_style_guide/Code_style_guide) - Coding style guidance for Mozilla projects.

### Google

- [Google-related developer documentation](https://developers.google.com/style) - This style guide provides editorial guidelines for writing clear and consistent Google-related developer documentation.

### Node.js

- [Microsoft + Node.js Guidelines](https://github.com/Microsoft/nodejs-guidelines) - Engineering guidelines for building Node.js apps.
- [Node.js Style Guide](https://github.com/felixge/node-style-guide) - A guide for styling your Node.js / JavaScript code.

### MongoDB

- [Mongo Style Guide](https://github.com/jsoendermann/MongoStyleGuide) - Style guidelines for MongoDB usage.

### SQL

- [SQL Style Guide](https://www.sqlstyle.guide) - SQL style and formatting guidelines.

### Other

- [Keep a CHANGELOG](http://keepachangelog.com/en/0.3.0/) - Guidelines for writing human-readable project changelogs.
- [Project Guidelines](https://github.com/elsewhencode/project-guidelines) - A set of best practices for JavaScript projects.
- [Semantic Versioning](http://semver.org)
- [Indent style](https://en.wikipedia.org/wiki/Indentation_style)
- [WebAppSec/Secure Coding Guidelines](https://wiki.mozilla.org/WebAppSec/Secure_Coding_Guidelines) - Secure coding guidelines for web applications.
- [Robot Framework User Guide](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html) - Official Robot Framework user guide.
- [CodeQL Coding Standards](https://github.com/github/codeql-coding-standards)

## Frameworks

- [Symfony Coding Standards](https://symfony.com/doc/current/contributing/code/standards.html)
- [Django Coding Style](https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style)
- [Vue Style Guide](https://vuejs.org/style-guide)
- [Angular Style Guide](https://angular.dev/style-guide)

## Content Management System

- [WordPress Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/)
- [Drupal Coding Standards](https://www.drupal.org/docs/develop/standards)
- [Magento Coding Standards](https://developer.adobe.com/commerce/php/coding-standards/)
- [Octobercms Developer Guide](https://octobercms.com/help/guidelines/developer)

## Tools

- [Agents.md](https://agents.md) - A simple, open format for guiding coding agents.
- [Checkstyle](https://github.com/checkstyle/checkstyle) - Tool for checking Java source code for adherence to a Code Standard or set of validation rules.
- [Conventional Changelog](https://github.com/conventional-changelog/conventional-changelog) - Generate changelogs from Git commits.
- [EasyCodingStandard](https://github.com/easy-coding-standard/easy-coding-standard) - The Easiest Way to Use Any Coding Standard.
- [ESLint](https://eslint.org/) - The pluggable linting utility for JavaScript and JSX.
- [JavaScript Standard Style](https://standardjs.com) - One JavaScript Style to Rule Them All.
- [Laravel Pint](https://laravel.com/docs/11.x/pint) - An opinionated PHP code style fixer for minimalists.
- [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) - The tool for detecting and fixing the violations of the specified standards in PHP code.
- [PHP Coding Standards Fixer](https://cs.symfony.com) - The PHP Coding Standards Fixer (PHP CS Fixer) tool fixes your code to follow standards.
- [RuboCop](https://rubocop.org) - A Ruby static code analyzer and formatter, based on the community Ruby style guide.
- [semantic-release](https://github.com/semantic-release/semantic-release) - Automated versioning and publishing from commits.
- [ShellCheck](https://github.com/koalaman/shellcheck) - A shell script static analysis tool.

---

--- METRICS ---
- Files Extracted: 1
- Estimated Token Budget: ~5590 tokens
- Canonical Reference: https://codewiki.google/github.com/Kristories/awesome-guidelines