# guides

**Repository Path**: mirrors_shakacode/guides

## Basic Information

- **Project Name**: guides
- **Description**: A guide for programming in style.
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-11-23
- **Last Updated**: 2026-04-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

ShakaCode fork of Thoughtbot's excellent "guides".

This gives us a scratchpad to update as we see fit, and possibly submit PR's back to Thoughtbot.

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)
  * [iOS](/protocol/ios)
  * [Open Source](/protocol/open-source)
  * [Product Review](/protocol/product-review)
  * [Rails](/protocol/rails)
* [Security](/security)
* [Style](/style)

High level guidelines:

* Be consistent.
* Don't rewrite existing code to follow this guide.
* Don't violate a guideline without a good reason.
* A reason is good when you can convince a teammate.

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.

Contributing
------------

Please read the [contribution guidelines] before submitting a pull request.

In particular: **if you have commit access, please don't merge changes without
waiting a week for everybody to leave feedback**.

[contribution guidelines]: /CONTRIBUTING.md

Credits
-------

Thank you, [contributors](https://github.com/thoughtbot/guides/graphs/contributors)!




License
-------

Guides is © 2014 thoughtbot, inc. It is distributed under the [Creative Commons
Attribution License](http://creativecommons.org/licenses/by/3.0/).

The names and logos for thoughtbot are trademarks of thoughtbot, inc.