Added contributing file [skip ci]
Andrew
committed Feb 16, 2018
commit 00b38cdb1372d6f81a1fb664fb1b86667172b24e
Showing 1
changed file with
37 additions
and 0 deletions
CONTRIBUTING.md
+37
-0
| @@ | @@ -0,0 +1,37 @@ |
| + | # Contributing |
| + | |
| + | First, thanks for wanting to contribute. You’re awesome! :heart: |
| + | |
| + | ## Questions |
| + | |
| + | Use [Stack Overflow](https://stackoverflow.com/) with the tag `ahoy`. |
| + | |
| + | ## Feature Requests |
| + | |
| + | Create an issue. Start the title with `[Idea]`. |
| + | |
| + | ## Issues |
| + | |
| + | Think you’ve discovered an issue? |
| + | |
| + | 1. Search existing issues to see if it’s been reported. |
| + | 2. Try the `master` branch to make sure it hasn’t been fixed. |
| + | |
| + | ```rb |
| + | gem "ahoy_matey", github: "ankane/ahoy" |
| + | ``` |
| + | |
| + | If the above steps don’t help, create an issue. Include the complete backtrace for exceptions. |
| + | |
| + | ## Pull Requests |
| + | |
| + | Fork the project and create a pull request. A few tips: |
| + | |
| + | - Keep changes to a minimum. If you have multiple features or fixes, submit multiple pull requests. |
| + | - Follow the existing style. The code should read like it’s written by a single person. |
| + | |
| + | Feel free to open an issue to get feedback on your idea before spending too much time on it. |
| + | |
| + | --- |
| + | |
| + | This contributing guide is released under [CCO](https://creativecommons.org/publicdomain/zero/1.0/) (public domain). Use it for your own project without attribution. |