kristories / awesome-guidelines

A curated list of high quality coding style conventions and standards.

Awesome Guidelines

A set of guidelines for a specific programming language that recommend programming style, practices, and methods for each aspect of a program written in that language.

Contents

• Programming Languages
• Development Environment
• Platforms
• Frameworks
• Content Management System
• Tools
• Contributors

Programming Languages

Brainfuck

• BF Style Guide

C

• C Coding Standard
• C Programming/Structure and style
• Making The Best Use of C - This chapter provides advice on how best to use the C language when writing GNU software.

C#

• C# Coding Conventions
• C# Style Guide
• C# Coding Standards and Naming Conventions

C++

• Google C++ Style Guide
• C++ Core Guidelines - A set of tried-and-true guidelines, rules, and best practices about coding in C++.
• LLVM C++ Coding Standards
• Mozilla C++ Coding style
• Chromium C++ style guide
• Webkit C++ Code Style Guidelines
• NASA C++ Coding Standards and Style Guide
• OceanBase C++ Coding Standards

Clojure

• The Clojure Style Guide - A community coding style guide for the Clojure programming language.

Common Lisp

• Style Guide
• Google Common Lisp Style Guide
• Common Lisp Style Guide

D

• The D Style - A set of style conventions for writing D programs.

Dart

• Effective Dart

Delphi

• Delphi's Object Pascal Style Guide

Elixir

• Elixir Styleguide

Elm

• Elm style guide

Emacs Lisp

• Elisp Guide
• Emacs Lisp Style Guide

Erlang

• Programming Rules and Conventions
• Erlang Coding Guidelines

F#

• The F# Component Design Guidelines

Fortran

• Fortran 90 Standards - European Standards For Writing and Documenting Exchangeable Fortran 90 Code.
• Fortran Best Practices - Style guide and best practices for modern Fortran programs.

Go

• Effective Go
• Go Standard Project Layout - Basic layout for Go applications.
• Google Go Style Guide - Google's coding standards for source code in Go.
• Uber Go Style Guide - Patterns and conventions used in Go code at Uber.

Groovy

• Apache Groovy style guide

Haskell

• Haskell Programming guidelines

Java

• Code Conventions for the Java™ Programming Language
• Google Java Style Guide - Google's coding standards for source code in the Java™ Programming Language.
• Java Programming Style Guide
• Alibaba-Java-Coding-Guidelines - A guide for Java developers.

JavaScript

• AngularJS Style Guide - Community-driven set of best practices for AngularJS application development.
• JavaScript The Right Way - An easy-to-read, quick reference for JS best practices, accepted coding standards, and links around the Web.
• Google JavaScript Style Guide - This document serves as the complete definition of Google's coding standards for source code in the JavaScript programming language.
• Airbnb JavaScript Style Guide - A mostly reasonable approach to JavaScript.
• jQuery Core Style Guide
• JavaScript Style Guides And Beautifiers
• JavaScript Style Guide and Coding Conventions
• Code Conventions for the JavaScript
• JavaScript Clean Code - Software engineering principles, from Robert C. Martin's book Clean Code, adapted for JavaScript.
• Mozilla Coding Style Guide for JavaScript

JSON

• Google JSON Style Guide

Julia

• Blue Style

Kotlin

• Coding Conventions

Lua

• Lua Style Guide

Markdown

• Google Markdown Style Guide - Style guide for Google-originated projects using Markdown.
• Markdown Style Guide
• GitLab Markdown Style Guide - Markdown Style Guide for about.GitLab.com.

.NET

• .NET Standard
• .NET Secure Coding Guidelines
• .NET Naming Guidelines

Nim

• Nim Style Guide

Objective-C

• Objective-C Style guide - Style guide & coding conventions for Objective-C projects.
• Google Objective-C Style Guide
• NYTimes Objective-C Style Guide - The Objective-C Style Guide used by The New York Times.

Pascal

• Coding style
• GNU Pascal Coding Standards - GNU Pascal standards used by GNU Pascal project.

Perl

• Perl best practices v4 - Slides by Randal Schwartz, based on the book by Damian Conway.
• Perl Elements to Avoid - A list of unrecommended practices, and what to do instead.
• perlstyle

PHP

• PHP FIG - PHP Standards Recommendations.
• PHP The Right Way - An easy-to-read, quick reference for PHP best practices, accepted coding standards, and links to authoritative tutorials around the Web.
• Clean Code PHP - Clean Code concepts adapted for PHP.

Python

• Style Guide for Python Code
• Google Python Style Guide
• The Hitchhiker's Guide to Python - Highly regarded Python best practices guide.

R

• Google's R Style Guide
• The tidyverse style guide

Racket

• How to Program Racket: a Style Guide

Ruby

• The Ruby Style Guide - A community-driven Ruby coding style guide.
• Ruby Style Guide - Airbnb's Ruby Style Guide.
• Ruby Style Guide - A community-driven Ruby coding style guide.

Rust

• Rust Style Guide
• Rust Guidelines
• Rust API Guidelines

Scala

• Effective Scala
• Scala Style Guide
• Databricks Scala Guide - Databricks Scala Coding Style Guide.
• Scala Best Practices

Solidity

• Solidity Style Guide
• Solcurity Standard

Swift

• API Design Guidelines
• Swift - GitHub Official Swift style and conventions.
• Swift style guide
• Swift Style Guide - LinkedIn Official Swift Style Guide.
• Metova's Swift style guide
• Xmartlabs Swift Style Guide - Swift language style guide & coding conventions followed by Xmartlabs.

TypeScript

• Google TypeScript Style Guide - TypeScript Style Guide used at Google's.
• Typescript deep dive - Style Guide - An unofficial TypeScript Style Guide.
• Typescript Lang - Do's and Don'ts - Suggestions from Typescript Lang organization.

Visual Basic

• Visual Basic Concepts
• Visual Basic/Coding Standards

XML

• Google XML Document Format Style Guide

Development Environment

Shell

• Shell Style Guide

Git

• Git Style Guide
• Few Rules from Git Documentation

PowerShell

• The PowerShell Best Practices and Style Guide - The Unofficial PowerShell Best Practices and Style Guide.

Platforms

Android

• Android Guidelines - Architecture and code guidelines we use at ribot when developing for Android.
• Xmartlabs Android Style Guide - Style guide for Android by Xmartlabs.

Apache

• Apache Developers' C Language Style Guide

API

• HAL - A simple format that gives a consistent and easy way to hyperlink between resources in your API.
• Microsoft REST API Guidelines - The Microsoft REST API Guidelines.
• JSON API - Recommendations - This section contains recommendations for JSON API implementations.
• API Security Checklist - Checklist of the most important security countermeasures when designing, testing, and releasing your API.
• Google Cloud API Design Guide - A general design guide for networked APIs provided by Google.

Arduino

• Arduino style guide
• API Style Guide for Arduino

Frontend Development

• CSS Guidelines - High-level advice and guidelines for writing sane, manageable, scalable CSS.
• Frontend Guidelines - Some HTML, CSS and JS best practices.
• Sass Guidelines - An opinionated styleguide for writing sane, maintainable and scalable Sass.
• Airbnb CSS / Sass Styleguide - A mostly reasonable approach to CSS and Sass.
• HTML Style Guide - A style guide which helps you write better, performant, structured, scalable and maintainable HTML.
• HTML + CSS Code Guide - Standards for flexible, durable, and sustainable HTML and CSS.
• U.S. Web Design Standards - Open source UI components and visual style guide for U.S. government websites.
• CoffeeScript Style Guide - A collection of best-practices and coding conventions for the CoffeeScript programming language.
• LESS Coding Guidelines
• Google HTML/CSS Style Guide
• Guidelines for Responsive Web Design
• Yelp Styleguide
• Front-End Checklist
• BEM - Block Element Modifier - A methodology that helps you to create reusable components and code sharing in front‑end development.

GNU

• GNU coding standards

Java

• JavaEE Specification

Linux

• Linux kernel coding style

Mailchimp

• Mailchimp Content Style Guide

Mozilla

• Mozilla Coding Style Guide

Google

• Google-related developer documentation - This style guide provides editorial guidelines for writing clear and consistent Google-related developer documentation.

Node.js

• Microsoft + Node.js Guidelines
• Node.js Style Guide - A guide for styling your Node.js / JavaScript code.

MongoDB

• Mongo Style Guide

SQL

• SQL Style Guide

Other

• Keep a CHANGELOG - Don't let your friends dump git logs into CHANGELOGs™.
• Project Guidelines - A set of best practices for JavaScript projects.
• Semantic Versioning
• Indent style
• WebAppSec/Secure Coding Guidelines
• Robot Framework User Guide
• CodeQL Coding Standards

Frameworks

• Symfony Coding Standards
• Django Coding Style
• Vue Style Guide
• Angular Style Guide

Content Management System

• WordPress Coding Standards
• Drupal Coding Standards
• Magento Coding Standards
• Octobercms Developer Guide

Tools

• Checkstyle - Tool for checking Java source code for adherence to a Code Standard or set of validation rules.
• Conventional Changelog
• EasyCodingStandard - The Easiest Way to Use Any Coding Standard.
• ESLint - The pluggable linting utility for JavaScript and JSX.
• JavaScript Standard Style - One JavaScript Style to Rule Them All.
• Laravel Pint - An opinionated PHP code style fixer for minimalists.
• North - Design and development standards to align and guide your project.
• PHP_CodeSniffer - The tool for detecting and fixing the violations of the specified standards in PHP code.
• PHP Coding Standards Fixer - The PHP Coding Standards Fixer (PHP CS Fixer) tool fixes your code to follow standards.
• RuboCop - A Ruby static code analyzer and formatter, based on the community Ruby style guide.
• semantic-release

Contributors

Contributions welcome. Please read the contribution guidelines before contributing.

Code Contributors

This project exists thanks to all the people who contribute.

Contribute on opencollective.com.