awesome-styleguides

:clipboard: A list of styleguides

Contents

• Contributing
• How to build a styleguide
• Other Styleguide Lists
• Styleguides
  • Generic
  • CSS
    • Sass
  • C++
  • Shell Script
  • Git
  • HTML
  • Java
  • JavaScript
    • AngularJS
    • CoffeeScript
    • HTTP Design
    • JSON
    • jQuery
    • Modules
    • npm
    • React
    • Riot
    • Vue
  • Lisp
  • Objective-C
  • PHP
  • Python
  • Ruby
    • Ruby on Rails
  • Rust
  • Swift
• Non-Code
  • Historical
• License

Contributing

If you have used any of these styleguides, please add a comment if you can! The more information, the better. Please look at the contributing file. Thanks!

How to build a styleguide

• A Maintainable Style Guide - By Ian Feather of Lonely Planet, advocates Style Guide Driven Development, which is pretty snazzy.
• Huge’s Styleguide Tool - A tool to make creating and maintaining style guides easy. Looks pretty decent, with a few uses cases and a significant following on GitHub.
• An In-Depth Overview Of Living Style Guide Tools - A good overview of what is out there.

Other Styleguide Lists

• Brand Style Guides - A beautiful website that lists where to find other styleguides. Maintained by @SaijoGeorge.
• Narkoz
• paulmillr
• SalGnt
• Styleguides.io
• UI Styleguides

Styleguides

Generic

• frontend-guidelines
• isobar

CSS

• CSS Best Practices
• CSSWizardry - This is the best there is. Made by one guy who consults for a lot of companies, this document pretty much sets the standards for how CSS should be used. Highly suggested.
• GitHub
• Google
• Idiomatic-CSS
• rscss - Reasonable Standard for CSS Stylesheet Structure.
• Smashing Magazine
• Trello
• Wordpress.org

Sass

• CSS-Tricks
• Sass Guidelines

C++

• Google

Shell Script

• Google

Git

• agis-
• Udacity - Git Commit Message Style Guide from Udacity.

HTML

• Google
• THX - Added because this is the first Chinese styleguide I have seen that has any significant amount of stars.

Java

• Android
• Google
• Sun

JavaScript

• Airbnb
• bevacqua’s JS sg
• feross/standard
• Google
• hapi
• Joyent
• jscs
• Khan
• Mozilla/pdf.js
• rsjs - Reasonable Standard for JavaScript Structure.

AngularJS

• gocardless
• Google
• johnpapa’s opinionated sg for AngularJS
• mgechev’s community best practices
• srph’s AngularJS structure sg
• Todd Motto’s for AngularJS
  • jmcunningham’s fork

CoffeeScript

• Polarmobile

HTTP Design

• http-api-design
• http-api-guide - Chinese.

JSON

• Google

jQuery

• Pragmatic jQuery

Modules

• mattdesl

npm

• npm Style Guide - An opinionated collection of best practices for teams by @deVoorhoede.

React

• John Cobb
• Khan

Riot

• RiotJS Style Guide - Opinionated RiotJS Style Guide for teams by @deVoorhoede.

Vue

• Vue Style Guide - The official style guide for Vue-specific code.

Lisp

• emacs-lips-style-guide

Objective-C

• Dropbox Objective-C Style Guide
• Futurice iOS Good Practices - iOS starting guide and good practices suggestions by @futurice.
• GitHub - Style guide & coding conventions for Swift projects A guide to our Swift style and conventions by @github.
• GitHub Objective-C Style Guide - Style guide & coding conventions for Objective-C projects.
• Khan
• NY Times - Objective C Style Guide - The Objective-C Style Guide used by The New York Times.
• Objective-C Coding Convention and Best Practices - Gist with coding conventions.
• raywenderlich Style Guide - A style guide that outlines the coding conventions for raywenderlich.com.
• Spotify Objective-C Coding Style - Guidelines for iOS development in use at Spotify.
• Swift Style Guide by @raywenderlich - The official Swift style guide for raywenderlich.com.

PHP

• PSR-1: Basic Coding Standard
• PSR-2: Coding Style Guide

Python

• Google
• PEP 8 Offical Style Guide for Python
• PEP 257 - Docstring Conventions
• The Hitchhiker’s Guide to Python
• wemake-python-styleguide - The strictest and most opinionated Python styleguide and linter ever.

Ruby

• Airbnb
• bbatsov
• GitHub - Based on bbatsov style guide.

Ruby on Rails

• bbastov’s Ruby on Rails 4 styleguide

Rust

• aturon

Swift

• Airbnb
• GitHub
• raywenderlich
• SlideShareInc

Non-Code

• BBC News Style Guide - The guide for all BBC News output covers spelling, punctuation and grammar, as well as accuracy, fairness and impartiality.
• Bishop Fox Cybersecurity Style Guide - From malicious viruses to viral memes, for security researchers.
• BuzzFeed Style Guide - An evolving set of standards for the internet and social media.
• Guardian and Observer Style Guide - The guide to writing, editing and English usage followed by journalists.
• Wikipedia Manual of Style - The style manual for all Wikipedia articles.

Historical

• Xerox Publishing Standards - The definitive reference to writing style and design for the business world. Provided courtesy of Xerox Corporation.

License

To the extent possible under law, Richard Littauer has waived all copyright and related or neighboring rights to this work.

styleguides.md Github