.github/contributing.md
Contributing
================================================================================
We love pull requests from everyone. By participating in this project, you
agree to abide by the code of conduct.
Here are some ways **you** can contribute:
* by using alpha, beta, and prerelease versions
* by reporting bugs
* by suggesting new features
* by writing or editing documentation
* by writing specifications
* by writing code
* by fixing styling inconsistencies
* by refactoring code
* by closing issues
* by reviewing patches
Submitting an Issue
--------------------------------------------------------------------------------
We use the GitHub issue tracker to track bugs and features. Before submitting
a bug report or feature request, check to make sure it hasn't already been
submitted. When submitting a bug report, please include a [Gist][gist] that
includes a stack trace and any details that may be necessary to reproduce the
bug. Ideally, a bug report should include a pull request with failing specs.
Submitting a Pull Request
--------------------------------------------------------------------------------
1. [Fork][fork] the official repository.
2. [Create a topic branch.][branch]
3. Implement your feature or bug fix.
4. Add, commit, and push your changes.
5. [Submit a pull request.][pr]
Notes
--------------------------------------------------------------------------------
* Please add tests if you changed code. Contributions without tests won't be
accepted.
Inspired by <https://github.com/thoughtbot/factory_bot/blob/master/CONTRIBUTING.md>
[branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/
[fork]: https://help.github.com/articles/fork-a-repo/
[gist]: https://gist.github.com/
[pr]: https://help.github.com/articles/using-pull-requests/