richardlitt / awesome-styleguides

:clipboard: A list of styleguides

awesome-styleguides

📋 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.

awesome-styleguides's Issues

Styleguides.io

Include those links here? https://github.com/maban/styleguides

@maban, maybe you have an idea? Styleguides.io is awesome.

Add comments for each item

This should be mandatory.

Match current standards for awesome-lists as defined by @sindresorhus

@sindresorhus has changed the standards for an awesome-list, and this list needs to be changed to match. See sindresorhus/awesome#926 for more.

Criteria

• Has been around for at least 30 days.
  That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent.
• It's the result of hard work and the best I could possibly produce.
• Non-generated Markdown file in a GitHub repo.
• The repo should have the following GitHub topics set: awesome-list, awesome, list. I encourage you to add more relevant topics.
• Not a duplicate.
• Includes a succinct description of the project/theme at the top of the readme. (Example)
• Only has awesome items. Awesome lists are curations of the best, not everything.
• Includes a project logo/illustration whenever possible.
  • Placed at the top-right of the readme. (Example)
  • The image should link to the project website or any relevant website.
  • The image should be high-DPI. Set it to maximum half the width of the original image.
• Entries have a description, unless the title is descriptive enough by itself. It rarely is though.
• Has the Awesome badge on the right side of the list heading,
• Has a Table of Contents section.
  • Should be named Contents, not Table of Contents.
  • Should be the first section in the list.
• Has an appropriate license.
  • That means something like CC0, not a code licence like MIT, BSD, Apache, etc.
  • If you use a license badge, it should be SVG, not PNG.
• Has contribution guidelines.
  • The file should be named contributing.md. Casing is up to you.
• Has consistent formatting and proper spelling/grammar.
  • Each link description starts with an uppercase character and ends with a period.
    Example: - [AVA](…) - JavaScript test runner.
  • Drop all the A / An prefixes in the descriptions.
  • Consistent naming. For example, Node.js, not NodeJS or node.js.
• Doesn't include a Travis badge.
  You can still use Travis for list linting, but the badge has no value in the readme.

Add license

Looking for Maintainers

I would like to have some help maintaining and overhauling this list. Is anyone interested?

Add contribute.md

New styleguide

This is kind of ad because I work at SC5 but we have a quite nice styleguide as well. You could go and check it at https://github.com/SC5/sc5-styleguide/ or at http://styleguide.sc5.io/.

There is also nice article about our styleguide so we are not only ones who think it's cool
http://www.smashingmagazine.com/2015/03/automating-style-guide-driven-development/

Add comments to styleguides

Go through the awesome-* lists looking for styleguides

https://github.com/sindresorhus/awesome