mirror of
https://github.com/varvet/pundit.git
synced 2022-11-09 12:30:11 -05:00
Add contributing file
This commit is contained in:
parent
bf086f0665
commit
06187d68f3
1 changed files with 33 additions and 0 deletions
33
CONTRIBUTING.md
Normal file
33
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,33 @@
|
|||
## Security issues
|
||||
|
||||
If you have found a security related issue, please do not file an issue on
|
||||
GitHub or send a PR addressing the issue. Contact
|
||||
[Jonas](mailto:jonas.nicklas@gmail.com) directly. You will be given public
|
||||
credit for your disclosure.
|
||||
|
||||
## Reporting issues
|
||||
|
||||
Please try to answer the following questions in your bug report:
|
||||
|
||||
- What did you do?
|
||||
- What did you expect to happen?
|
||||
- What happened instead?
|
||||
|
||||
Make sure to include as much relevant information as possible. Ruby version,
|
||||
Pundit version, OS version and any stack traces you have are very valuable.
|
||||
|
||||
## Pull Requests
|
||||
|
||||
- **Add tests!** Your patch won't be accepted if it doesn't have tests.
|
||||
|
||||
- **Document any change in behaviour**. Make sure the README and any other
|
||||
relevant documentation are kept up-to-date.
|
||||
|
||||
- **Create topic branches**. Please don't ask us to pull from your master branch.
|
||||
|
||||
- **One pull request per feature**. If you want to do more than one thing, send
|
||||
multiple pull requests.
|
||||
|
||||
- **Send coherent history**. Make sure each individual commit in your pull
|
||||
request is meaningful. If you had to make multiple intermediate commits while
|
||||
developing, please squash them before sending them to us.
|
Loading…
Reference in a new issue