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