fucking-awesome-guidelines

Awesome Guidelines

Programming style, best practices, and coding conventions.

Contents

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

Programming Languages

Brainfuck

• 🌎 BF Style Guide - Guidelines for writing and formatting Brainfuck code.

C

• 🌎 C Coding Standard - Conventions and best practices for C code.
• 🌎 C Programming/Structure and style - Structural and style recommendations for C programs.
• 🌎 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 - Official C# coding style conventions.
•    502⭐    106🍴 C# Style Guide) - Community C# style guide.
• C# Coding Standards and Naming Conventions - Standards and naming conventions for C# code.

C++

• 🌎 Google C++ Style Guide - C++ coding standards and best practices.
• C++ Core Guidelines - A set of tried-and-true guidelines, rules, and best practices about coding in C++.
• 🌎 LLVM C++ Coding Standards - Coding standards for the LLVM project.
• 🌎 Mozilla C++ Coding style - C++ coding style guidelines for Mozilla codebases.
• 🌎 Chromium C++ style guide - C++ style guide for the Chromium project.
• 🌎 Webkit C++ Code Style Guidelines - C++ code style guidelines for WebKit.
• 🌎 NASA C++ Coding Standards and Style Guide - C++ coding standards for safety-critical systems.
• 🌎 OceanBase C++ Coding Standards - C++ coding standards for OceanBase.

Clojure

•   4097⭐    282🍴 The Clojure Style Guide) - A community coding style guide for the Clojure programming language.

Common Lisp

• Style Guide
• 🌎 Google Common Lisp Style Guide

D

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

Dart

• 🌎 Effective Dart - Recommendations for consistent, idiomatic Dart code.

Delphi

• 🌎 Delphi's Object Pascal Style Guide - Object Pascal coding style guidelines.

Elixir

•   4429⭐    300🍴 Elixir Styleguide) - Community Elixir coding style guide.

Elm

• Elm style guide - Style suggestions and conventions for Elm.

Emacs Lisp

•   1487⭐     94🍴 Elisp Guide) - Guide to writing Emacs Lisp.
•   1133⭐     53🍴 Emacs Lisp Style Guide) - Community style guide for Emacs Lisp.

Erlang

• 🌎 Secure Coding Guidelines - Writing secure Erlang code, describing common pitfalls and weaknesses best avoided.
•    642⭐    122🍴 Erlang Coding Guidelines)

F#

• 🌎 The F# Component Design Guidelines - Official design and style guidelines for F#.

Fortran

• 🌎 Fortran Best Practices - Style guide and best practices for modern Fortran programs.

Go

• 🌎 Effective Go - Idioms and best practices for Go.
•  56427⭐   5430🍴 Go Standard Project Layout) - Basic layout for Go applications.
• 🌎 Google Go Style Guide - Google's coding standards for source code in Go.
•  17648⭐   1811🍴 Uber Go Style Guide) - Patterns and conventions used in Go code at Uber.

Groovy

• Apache Groovy style guide - Style guide for writing idiomatic Groovy code.

Haskell

• 🌎 Haskell Programming guidelines - Best practices for Haskell programming.

Java

• Code Conventions for the Java™ Programming Language - Historical Java coding conventions.
• 🌎 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

•   4920⭐    634🍴 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.
• 148116⭐  26609🍴 Airbnb JavaScript Style Guide) - A mostly reasonable approach to JavaScript.
• jQuery Core Style Guide - JavaScript style rules for open-source contributors.
• 🌎 JavaScript Style Guides And Beautifiers - Roundup of JavaScript style guides and formatting tools.
• 🌎 JavaScript Style Guide and Coding Conventions - General JavaScript coding conventions and best practices.
• 🌎 Code Conventions for the JavaScript - A set of coding conventions and rules for use in JavaScript programming.
•  94763⭐  12617🍴 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 - Recommendations for JSON formatting and usage.

Julia

•    515⭐     34🍴 Blue Style) - Community style guide for Julia packages.

Kotlin

• 🌎 Coding Conventions - Official Kotlin coding conventions.

Lua

• Lua Style Guide - Community Lua coding style guide.

Markdown

•  39491⭐  12947🍴 Google Markdown Style Guide) - Style guide for Google-originated projects using Markdown.
• Markdown Style Guide - Practical guidelines for writing readable Markdown.
• 🌎 GitLab Markdown Style Guide - Markdown Style Guide for about.GitLab.com.

.NET

•   3038⭐    417🍴 .NET Standard) - Formal specification of .NET APIs that are available across .NET implementations.
• 🌎 .NET Secure Coding Guidelines - Guidance for writing secure .NET code.
• 🌎 .NET Naming Guidelines - Naming conventions for .NET libraries.

Nim

• 🌎 Nim Style Guide - Style conventions and RFC for Nim code.

Objective-C

•   1665⭐    241🍴 Objective-C Style guide) - Style guide & coding conventions for Objective-C projects.
•  39491⭐  12947🍴 Google Objective-C Style Guide) - Objective-C coding standards and conventions.
•   5818⭐   1236🍴 NYTimes Objective-C Style Guide) - The Objective-C Style Guide used by The New York Times.

Pascal

• Coding style - Style recommendations for Free Pascal.
• 🌎 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 - Perl style guidelines.

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.
•  12452⭐   2253🍴 Clean Code PHP) - Clean Code concepts adapted for PHP.

Python

• 🌎 Style Guide for Python Code - Official Python style guide (PEP 8).
• 🌎 Google Python Style Guide - Python coding standards.
• 🌎 The Hitchhiker's Guide to Python - Highly regarded Python best practices guide.

R

• 🌎 Google's R Style Guide - R style conventions.
• The tidyverse style guide - Style guide for R code in the tidyverse.

Racket

• How to Program Racket: a Style Guide - Style guidance for Racket programs.

Ruby

• 🌎 The Ruby Style Guide - A community-driven Ruby coding style guide.
•   3890⭐    756🍴 Ruby Style Guide) - Airbnb's Ruby Style Guide.
•  16551⭐   3341🍴 Ruby Style Guide) - A community-driven Ruby coding style guide.

Rust

• 115390⭐  15405🍴 Rust Style Guide)
• 🌎 Rust API Guidelines - Guidelines for designing public Rust APIs.

Scala

• 🌎 Effective Scala - Best practices and patterns for Scala.
• Scala Style Guide - Official style guide for Scala code.
•   2806⭐    579🍴 Databricks Scala Guide) - Databricks Scala Coding Style Guide.
•   4351⭐    613🍴 Scala Best Practices) - Recommendations and patterns for Scala development.

Solidity

• 🌎 Solidity Style Guide - Style guidelines for Solidity smart contracts.
•   2184⭐    276🍴 Solcurity Standard) - Security checklist and guidelines for Solidity smart contracts.

Swift

• 🌎 API Design Guidelines - API design principles for Swift.
•   4758⭐    561🍴 Swift) - GitHub Official Swift style and conventions.
•  13163⭐   2098🍴 Swift style guide) - Community Swift style guide.
•   1454⭐    191🍴 Swift Style Guide) - LinkedIn Official Swift Style Guide.
•      0⭐      0🍴 Metova's Swift style guide) - Swift style guide for Xcode (archived, deprecated 2022).
•     44⭐      6🍴 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 - Concepts and coding practices for classic Visual Basic.
• 🌎 Visual Basic/Coding Standards - Coding standards for Visual Basic projects.

XML

• 🌎 Google XML Document Format Style Guide - XML formatting and style guidance.

Development Environment

Shell

• 🌎 Shell Style Guide - Shell script style guide.

Git

•   5118⭐    411🍴 Git Style Guide) - Git usage and style recommendations.
•  62496⭐  28229🍴 Few Rules from Git Documentation) - Coding guidelines used in the Git project.

PowerShell

•   2427⭐    294🍴 The PowerShell Best Practices and Style Guide) - The Unofficial PowerShell Best Practices and Style Guide.

Platforms

Android

•   4999⭐   1343🍴 Android Guidelines) - Architecture and code guidelines we use at ribot when developing for Android.
•      7⭐      5🍴 Xmartlabs Android Style Guide) - Style guide for Android by Xmartlabs.

Apache

• Apache Developers' C Language Style Guide - C language style guidelines for the Apache HTTP Server project.

API

• HAL - A simple format that gives a consistent and easy way to hyperlink between resources in your API.
•  23317⭐   2695🍴 Microsoft REST API Guidelines) - The Microsoft REST API Guidelines.
• JSON API - Recommendations - This section contains recommendations for JSON API implementations.
•  23294⭐   2652🍴 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 - General coding style guidance for Arduino.
• 🌎 API Style Guide for Arduino

Frontend Development

• 🌎 CSS Guidelines - High-level advice and guidelines for writing sane, manageable, scalable CSS.
•   9114⭐    679🍴 Frontend Guidelines) - Some HTML, CSS and JS best practices.
• 🌎 Sass Guidelines - An opinionated styleguide for writing sane, maintainable and scalable Sass.
•   6978⭐   1396🍴 Airbnb CSS / Sass Styleguide) - A mostly reasonable approach to CSS and Sass.
•     41⭐      5🍴 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.
•   1630⭐    265🍴 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 - Guide to designing for screen size, platform, and orientation.
• 🌎 Yelp Styleguide - Design system for consistent product UI.
•  73479⭐   6664🍴 Front-End Checklist) - Pre-launch checklist for front-end projects.
• 🌎 BEM - Block Element Modifier - A methodology that helps you to create reusable components and code sharing in front‑end development.
• 🌎 Web Content Accessibility Guidelines (WCAG) 2.1 - Recommendations for making web content more accessible.

GNU

• 🌎 GNU coding standards - Coding and documentation standards for GNU software.

Java

•    381⭐     66🍴 JavaEE Specification) - Official specification for Java EE.

Linux

• 🌎 Linux kernel coding style - Coding style for the Linux kernel.

Mailchimp

• 🌎 Mailchimp Content Style Guide - Content style guidelines for Mailchimp.

Mozilla

• 🌎 Mozilla Coding Style Guide - Coding style guidance for Mozilla projects.

Google

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

Node.js

•   2498⭐    278🍴 Microsoft + Node.js Guidelines) - Engineering guidelines for building Node.js apps.
•   4992⭐    897🍴 Node.js Style Guide) - A guide for styling your Node.js / JavaScript code.

MongoDB

•     89⭐     12🍴 Mongo Style Guide) - Style guidelines for MongoDB usage.

SQL

• 🌎 SQL Style Guide - SQL style and formatting guidelines.

Other

• Keep a CHANGELOG - Guidelines for writing human-readable project changelogs.
•  29453⭐   3146🍴 Project Guidelines) - A set of best practices for JavaScript projects.
• Semantic Versioning
• 🌎 Indent style
• 🌎 WebAppSec/Secure Coding Guidelines - Secure coding guidelines for web applications.
• 🌎 Robot Framework User Guide - Official Robot Framework user guide.
•    223⭐     78🍴 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

• 🌎 Agents.md - A simple, open format for guiding coding agents.
•   8991⭐   4155🍴 Checkstyle) - Tool for checking Java source code for adherence to a Code Standard or set of validation rules.
•   8496⭐    742🍴 Conventional Changelog) - Generate changelogs from Git commits.
•   1620⭐     92🍴 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.
•  10773⭐   1451🍴 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.
•  23964⭐   1810🍴 semantic-release) - Automated versioning and publishing from commits.
•  39845⭐   1940🍴 ShellCheck) - A shell script static analysis tool.

Source

 11020⭐    617🍴 Kristories/awesome-guidelines)