brew/CONTRIBUTING.md

# Contributing to Homebrew
## Reporting Bugs
First, please run `brew update` and `brew doctor`.

Second, read the [Troubleshooting Checklist](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Troubleshooting.md#troubleshooting).

**If you don't read these it will take us far longer to help you with your problem.**

## Security
Please report security issues to security@brew.sh.

## Contributing
Please read:

* [Code of Conduct](https://github.com/Homebrew/homebrew/blob/master/CODEOFCONDUCT.md#code-of-conduct)

To contribute code please read:

* [Formula API](http://www.rubydoc.info/github/Homebrew/homebrew/master/frames)
* [Formula Cookbook](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Formula-Cookbook.md#formula-cookbook)
* [Acceptable Formulae](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Acceptable-Formulae.md#acceptable-formulae)
* [Ruby Style Guide](https://github.com/styleguide/ruby)
* [How To Open a Homebrew Pull Request (and get it merged)](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md#how-to-open-a-homebrew-pull-request-and-get-it-merged)

Thanks!
Cleanup root documentation. 2014-10-26 15:23:42 +00:00			`# Contributing to Homebrew`
			`## Reporting Bugs`
CONTRIBUTING: shorten troubleshooting wording. 2014-01-18 14:30:57 -08:00			First, please run `brew update` and `brew doctor`.
Add Contributing Guidelines. 2012-09-22 12:41:56 +01:00
Cleanup root documentation. 2014-10-26 15:23:42 +00:00			`Second, read the [Troubleshooting Checklist](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Troubleshooting.md#troubleshooting).`
Add Contributing Guidelines. 2012-09-22 12:41:56 +01:00
			`If you don't read these it will take us far longer to help you with your problem.`

Cleanup root documentation. 2014-10-26 15:23:42 +00:00			`## Security`
Add security contact 2014-10-22 17:23:17 -05:00			`Please report security issues to security@brew.sh.`

Cleanup root documentation. 2014-10-26 15:23:42 +00:00			`## Contributing`
Add Contributing Guidelines. 2012-09-22 12:41:56 +01:00			`Please read:`

Cleanup root documentation. 2014-10-26 15:23:42 +00:00			`* [Code of Conduct](https://github.com/Homebrew/homebrew/blob/master/CODEOFCONDUCT.md#code-of-conduct)`
The Formula API is no longer work-in-progress. Feature it a bit more prominently in the documentation as a result. Closes Homebrew/homebrew#45374. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com> 2015-10-26 21:04:12 -06:00
			`To contribute code please read:`

			`* [Formula API](http://www.rubydoc.info/github/Homebrew/homebrew/master/frames)`
Cleanup root documentation. 2014-10-26 15:23:42 +00:00			`* [Formula Cookbook](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Formula-Cookbook.md#formula-cookbook)`
			`* [Acceptable Formulae](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Acceptable-Formulae.md#acceptable-formulae)`
CONTRIBUTING: add Ruby style guide. 2014-01-05 14:43:37 +00:00			`* [Ruby Style Guide](https://github.com/styleguide/ruby)`
Cleanup root documentation. 2014-10-26 15:23:42 +00:00			`* [How To Open a Homebrew Pull Request (and get it merged)](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md#how-to-open-a-homebrew-pull-request-and-get-it-merged)`
Add Contributing Guidelines. 2012-09-22 12:41:56 +01:00
			`Thanks!`