|
| 1 | +# Contributing to blues/note-c |
| 2 | + |
| 3 | +We love pull requests from everyone. By participating in this project, you |
| 4 | +agree to abide by the Blues Inc [code of conduct]. |
| 5 | + |
| 6 | +[code of conduct]: https://blues.github.io/opensource/code-of-conduct |
| 7 | + |
| 8 | +Here are some ways *you* can contribute: |
| 9 | + |
| 10 | +* by using alpha, beta, and prerelease versions |
| 11 | +* by reporting bugs |
| 12 | +* by suggesting new features |
| 13 | +* by writing or editing documentation |
| 14 | +* by writing specifications |
| 15 | +* by writing code ( **no patch is too small** : fix typos, add comments, |
| 16 | +clean up inconsistent whitespace ) |
| 17 | +* by refactoring code |
| 18 | +* by closing [issues][] |
| 19 | +* by reviewing patches |
| 20 | + |
| 21 | +[issues]: https://github.com/blues/note-c/issues |
| 22 | + |
| 23 | +## Submitting an Issue |
| 24 | + |
| 25 | +* We use the [GitHub issue tracker][issues] to track bugs and features. |
| 26 | +* Before submitting a bug report or feature request, check to make sure it |
| 27 | + hasn't |
| 28 | + already been submitted. |
| 29 | +* When submitting a bug report, please include a [Gist][] that includes a stack |
| 30 | + trace and any details that may be necessary to reproduce the bug, including |
| 31 | + your gem version, Ruby version, and operating system. Ideally, a bug report |
| 32 | + should include a pull request with failing specs. |
| 33 | + |
| 34 | +[gist]: https://gist.github.com/ |
| 35 | + |
| 36 | +## Cleaning up issues |
| 37 | + |
| 38 | +* Issues that have no response from the submitter will be closed after 30 days. |
| 39 | +* Issues will be closed once they're assumed to be fixed or answered. If the |
| 40 | + maintainer is wrong, it can be opened again. |
| 41 | +* If your issue is closed by mistake, please understand and explain the issue. |
| 42 | + We will happily reopen the issue. |
| 43 | + |
| 44 | +## Submitting a Pull Request |
| 45 | +1. [Fork][fork] the [official repository][repo]. |
| 46 | +2. [Create a topic branch.][branch] |
| 47 | +3. Implement your feature or bug fix. |
| 48 | +4. Add, commit, and push your changes. |
| 49 | +5. [Submit a pull request.][pr] |
| 50 | + |
| 51 | +## Notes |
| 52 | +* Please add tests if you changed code. Contributions without tests won't be |
| 53 | +* accepted. If you don't know how to add tests, please put in a PR and leave a |
| 54 | +* comment asking for help. We love helping! |
| 55 | + |
| 56 | +[repo]: https://github.com/blues/note-c/tree/master |
| 57 | +[fork]: https://help.github.com/articles/fork-a-repo/ |
| 58 | +[branch]: |
| 59 | +https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/ |
| 60 | +[pr]: https://help.github.com/articles/creating-a-pull-request-from-a-fork/ |
| 61 | + |
| 62 | +Inspired by |
| 63 | +https://github.com/thoughtbot/factory_bot/blob/master/CONTRIBUTING.md |
| 64 | + |
0 commit comments