awesome-styleguides [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome) =================== _:clipboard: A list of styleguides_ # Contents - [Contributing](#contributing) - [How to build a styleguide](#how-to-build-a-styleguide) - [Other Styleguide Lists](#other-styleguide-lists) - [Styleguides](#styleguides) - [Generic](#generic) - [CSS](#css) - [Sass](#sass) - [C++](#c) - [Shell Script](#shell-script) - [Git](#git) - [HTML](#html) - [Java](#java) - [JavaScript](#javascript) - [AngularJS](#angularjs) - [CoffeeScript](#coffeescript) - [HTTP Design](#http-design) - [JSON](#json) - [jQuery](#jquery) - [Modules](#modules) - [npm](#npm) - [React](#react) - [Riot](#riot) - [Vue](#vue) - [Lisp](#lisp) - [Objective-C](#objective-c) - [PHP](#php) - [Python](#python) - [Ruby](#ruby) - [Ruby on Rails](#ruby-on-rails) - [Rust](#rust) - [Swift](#swift) - [Non-Code](#non-code) - [Historical](#historical) - [License](#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](https://github.com/RichardLitt/awesome-styleguides/blob/master/contributing.md) file. Thanks! # How to build a styleguide * [A Maintainable Style Guide](http://ianfeather.co.uk/a-maintainable-style-guide/) - By Ian Feather of Lonely Planet, advocates Style Guide Driven Development, which is pretty snazzy. * [Huge's Styleguide Tool](https://github.com/hugeinc/styleguide) - 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](http://www.smashingmagazine.com/2015/04/an-in-depth-overview-of-living-style-guide-tools/) - A good overview of what is out there. # Other Styleguide Lists * [Brand Style Guides](https://saijogeorge.com/brand-style-guide-examples/) - A beautiful website that lists where to find other styleguides. Maintained by [@SaijoGeorge](https://twitter.com/SaijoGeorge). * [Narkoz](https://github.com/narkoz/guides) * [paulmillr](https://github.com/paulmillr/code-style-guides) * [SalGnt](https://github.com/SalGnt/cscs) * [Styleguides.io](https://github.com/maban/styleguides) * [UI Styleguides](http://kevinwuhoo.github.io/ui-styleguides) # Styleguides ## Generic * [frontend-guidelines](https://github.com/bendc/frontend-guidelines) * [isobar](https://isobar-idev.github.io/code-standards/) ## CSS * [CSS Best Practices](https://github.com/sezgi/CSS-Best-Practices) * [CSSWizardry](http://cssguidelin.es/) - 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](http://primercss.io) * [Google](https://google.github.io/styleguide/htmlcssguide.xml) * [Idiomatic-CSS](https://github.com/necolas/idiomatic-css) * [rscss](https://github.com/rstacruz/rscss) - Reasonable Standard for CSS Stylesheet Structure. * [Smashing Magazine](http://www.smashingmagazine.com/2008/05/improving-code-readability-with-css-styleguides/) * [Trello](https://gist.github.com/bobbygrace/9e961e8982f42eb91b80) * [Wordpress.org](https://make.wordpress.org/core/handbook/best-practices/coding-standards/css/) ### Sass * [CSS-Tricks](https://css-tricks.com/sass-style-guide/) * [Sass Guidelines](http://sass-guidelin.es/) ## C++ * [Google](https://google.github.io/styleguide/cppguide.html) ## Shell Script * [Google](https://google.github.io/styleguide/shell.xml) ## Git * [agis-](https://github.com/agis-/git-style-guide) * [Udacity](https://udacity.github.io/git-styleguide/) - Git Commit Message Style Guide from Udacity. ## HTML * [Google](https://google.github.io/styleguide/htmlcssguide.xml) * [THX](https://github.com/thx/html-code-guide) - Added because this is the first Chinese styleguide I have seen that has any significant amount of stars. ## Java * [Android](http://source.android.com/source/code-style.html) * [Google](https://google.github.io/styleguide/javaguide.html) * [Sun](http://javascript.crockford.com/javacodeconventions.pdf) ## JavaScript * [Airbnb](https://github.com/airbnb/javascript) * [bevacqua's JS sg](https://github.com/bevacqua/js) * [feross/standard](https://github.com/feross/standard) * [Google](https://google.github.io/styleguide/jsguide.html) * [hapi](http://hapijs.com/styleguide) * [Joyent](https://www.joyent.com/developers/node/design) * [jscs](https://github.com/jscs-dev/node-jscs) * [Khan](https://github.com/Khan/style-guides/blob/master/style/javascript.md) * [Mozilla/pdf.js](https://github.com/mozilla/pdf.js/wiki/Style-Guide) * [rsjs](https://github.com/rstacruz/rsjs) - Reasonable Standard for JavaScript Structure. ### AngularJS * [gocardless](https://github.com/gocardless/angularjs-style-guide) * [Google](https://google.github.io/styleguide/angularjs-google-style.html) * [johnpapa's opinionated sg for AngularJS](https://github.com/johnpapa/angular-styleguide) * [mgechev's community best practices](https://github.com/mgechev/angularjs-style-guide) * [srph's AngularJS structure sg](https://github.com/srph/angularjs-structure-styleguide) * [Todd Motto's for AngularJS](https://github.com/toddmotto/angularjs-styleguide) * [jmcunningham's fork](https://github.com/jmcunningham/angularjs-styleguide) ### CoffeeScript * [Polarmobile](https://github.com/polarmobile/coffeescript-style-guide) ### HTTP Design * [http-api-design](https://github.com/interagent/http-api-design) * [http-api-guide](https://github.com/bolasblack/http-api-guide) - Chinese. ### JSON * [Google](https://google.github.io/styleguide/jsoncstyleguide.xml) ### jQuery * [Pragmatic jQuery](https://github.com/yuanyan/pragmatic-jquery) ### Modules * [mattdesl](https://github.com/mattdesl/module-best-practices) ### npm * [npm Style Guide](https://github.com/voorhoede/npm-style-guide#readme) - An opinionated collection of best practices for teams by [@deVoorhoede](https://twitter.com/devoorhoede). ### React * [John Cobb](https://web-design-weekly.com/2015/01/29/opinionated-guide-react-js-best-practices-conventions/) * [Khan](https://github.com/Khan/style-guides/blob/master/style/react.md) ### Riot * [RiotJS Style Guide](https://github.com/voorhoede/riotjs-style-guide#readme) - Opinionated RiotJS Style Guide for teams by [@deVoorhoede](https://twitter.com/devoorhoede). ### Vue * [Vue Style Guide](https://vuejs.org/v2/style-guide/) - The official style guide for Vue-specific code. ## Lisp * [emacs-lips-style-guide](https://github.com/bbatsov/emacs-lisp-style-guide) ## Objective-C * [Dropbox Objective-C Style Guide](https://dl.dropboxusercontent.com/s/5utnlwhr18ax05c/style-guide.html?dl=0) * [Futurice iOS Good Practices](https://github.com/futurice/ios-good-practices) - iOS starting guide and good practices suggestions by [@futurice](https://github.com/futurice). * [GitHub - Style guide & coding conventions for Swift projects](https://github.com/github/swift-style-guide) A guide to our Swift style and conventions by @github. * [GitHub Objective-C Style Guide](https://github.com/github/objective-c-style-guide) - Style guide & coding conventions for Objective-C projects. * [Khan](https://github.com/Khan/objective-c-style-guide) * [NY Times - Objective C Style Guide](https://github.com/NYTimes/objective-c-style-guide) - The Objective-C Style Guide used by The New York Times. * [Objective-C Coding Convention and Best Practices](https://gist.github.com/soffes/812796) - Gist with coding conventions. * [raywenderlich Style Guide](https://github.com/raywenderlich/objective-c-style-guide) - A style guide that outlines the coding conventions for raywenderlich.com. * [Spotify Objective-C Coding Style](https://github.com/spotify/ios-style) - Guidelines for iOS development in use at Spotify. * [Swift Style Guide by @raywenderlich](https://github.com/raywenderlich/swift-style-guide) - The official Swift style guide for raywenderlich.com. ## PHP * [PSR-1: Basic Coding Standard](http://www.php-fig.org/psr/psr-1/) * [PSR-2: Coding Style Guide](http://www.php-fig.org/psr/psr-2/) ## Python * [Google](https://google.github.io/styleguide/pyguide.html) * [PEP 8 Offical Style Guide for Python](https://pep8.org/) * [PEP 257 - Docstring Conventions](http://legacy.python.org/dev/peps/pep-0257/) * [The Hitchhiker's Guide to Python](http://docs.python-guide.org/en/latest/writing/style/) * [wemake-python-styleguide](https://github.com/wemake-services/wemake-python-styleguide) - The strictest and most opinionated Python styleguide and linter ever. ## Ruby * [Airbnb](https://github.com/airbnb/ruby) * [bbatsov](https://github.com/bbatsov/ruby-style-guide) * [GitHub](https://github.com/styleguide/ruby) - Based on bbatsov style guide. ### Ruby on Rails * [bbastov's Ruby on Rails 4 styleguide](https://github.com/bbatsov/rails-style-guide) ## Rust * [aturon](https://aturon.github.io) ## Swift * [Airbnb](https://github.com/airbnb/swift) * [GitHub](https://github.com/github/swift-style-guide) * [raywenderlich](https://github.com/raywenderlich/swift-style-guide) * [SlideShareInc](https://github.com/SlideShareInc/swift-style-guide) # Non-Code * [BBC News Style Guide](https://www.bbc.co.uk/academy/en/collections/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](https://www.bishopfox.com/blog/2018/02/hello-world-introducing-the-bishop-fox-cybersecurity-style-guide/) - From malicious viruses to viral memes, for security researchers. * [BuzzFeed Style Guide](https://www.buzzfeed.com/emmyf/buzzfeed-style-guide) - An evolving set of standards for the internet and social media. * [Guardian and Observer Style Guide](https://www.theguardian.com/info/series/guardian-and-observer-style-guide) - The guide to writing, editing and English usage followed by journalists. * [Wikipedia Manual of Style](https://en.wikipedia.org/wiki/Wikipedia%3aManual_of_Style) - The style manual for all Wikipedia articles. ## Historical * [Xerox Publishing Standards](https://archive.org/details/xeroxpublishingstan00xero) - The definitive reference to writing style and design for the business world. Provided courtesy of Xerox Corporation. # License [![CC0](http://mirrors.creativecommons.org/presskit/buttons/88x31/svg/cc-zero.svg)](https://creativecommons.org/publicdomain/zero/1.0/) To the extent possible under law, [Richard Littauer](http://burntfen.com) has waived all copyright and related or neighboring rights to this work. [styleguides.md Github](https://github.com/RichardLitt/awesome-styleguides )