An open API service indexing awesome lists of open source software.

https://github.com/subvisual/guides


https://github.com/subvisual/guides

Last synced: 10 months ago
JSON representation

Awesome Lists containing this project

README

          

Guides
======

Guides for getting things done, programming well, and programming in style.

* [Best Practices](/best-practices)
* [Code Review](/code-review)
* [Protocol](/protocol)
* [Communication](/protocol/communication)
* [Git](/protocol/git)
* [Rails](/protocol/rails)
* [Style](/style)
* [Ruby](/style/ruby)
* [Sass](/style/sass)
* [JavaScript](/style/js)
* [Templating](/style/templating)
* [Linters](/linters)
* [Trello](/trello)
* [Github](/github)
* [DevOps](/devops)

High level guidelines:

* Be consistent.
* Don't rewrite existing code to follow this guide.
* Don't violate the conventions without a good reason.

A note on the language:

* "Avoid" means don't do it unless you have good reason.
* "Don't" means there's never a good reason.
* "Prefer" indicates a better option and its alternative to watch out for.
* "Use" is a positive instruction.

Credits
-------

Thanks to [thoughtbot](http://thoughtbot.com/) from whom these guides are based.

These guides are maintained by [Subvisual](https://subvisual.com)
The names and logos for Subvisual are trademarks of GB-Software As A Service, Lda.

These guides are © 2017 GB-Software As A Service, Lda.
They are distributed under the [Creative Commons
Attribution License](http://creativecommons.org/licenses/by/3.0/).