CONTRIBUTING.md 1.45 KB
Newer Older
Bryan Rite's avatar
Bryan Rite committed
1
## Contributing to CanCanCan
Vasiliy Ermolovich's avatar
Vasiliy Ermolovich committed
2

Bryan Rite's avatar
Bryan Rite committed
3
### Reporting an Issue
Vasiliy Ermolovich's avatar
Vasiliy Ermolovich committed
4

5
6
7
1. If you have any questions about CanCanCan, search the [Wiki](https://github.com/cancancommunity/cancancan/wiki) or 
use [Stack Overflow](http://stackoverflow.com/questions/tagged/cancancan). 
Do not post questions here.
Vasiliy Ermolovich's avatar
Vasiliy Ermolovich committed
8

9
1. If you find a security bug, **DO NOT** submit an issue here. Please send an e-mail to the [current maintainer](https://github.com/coorasse) instead.
Bryan Rite's avatar
Bryan Rite committed
10
11
12

1. Do a small search on the issues tracker before submitting your issue to see if it was already reported / fixed.

13
1. Create your report including Rails and CanCanCan versions. If you are getting exceptions, please include the full backtrace. Use the [following gist](https://gist.github.com/coorasse/3f00f536563249125a37e15a1652648c) as a base to reproduce your bug.
Vasiliy Ermolovich's avatar
Vasiliy Ermolovich committed
14

15
That's it! The more information you give, the more easy it becomes for us to track it down and fix it. Ideal scenario would be adding the issue to CanCanCan test suite or to a sample application.
Vasiliy Ermolovich's avatar
Vasiliy Ermolovich committed
16

Bryan Rite's avatar
Bryan Rite committed
17
18
### Adding new Features or Bugfixes

19
20
21
CanCanCan uses a [git-flow](http://nvie.com/posts/a-successful-git-branching-model/) development model.
The latest "released" version of CanCanCan, the latest gem version, can always be found on `master`, 
while the next version or nightly is on `develop`.
Bryan Rite's avatar
Bryan Rite committed
22
23
24
25
26

Please make sure you have test coverage for anything you add or fix!

Please add a CHANGELOG entry with any relevant tags for issues, pull-requests, and authors.

27
Thanks for you contribution!