Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Update documentation.

  • Loading branch information...
commit c8ac15e7d499c30afc5d5df158a37afd75d5858a 1 parent f28ddcc
Bryan Rite bryanrite authored
Showing with 20 additions and 9 deletions.
  1. +16 −4 CONTRIBUTING.md
  2. +3 −3 README.rdoc
  3. +1 −2  spec/README.rdoc
20 CONTRIBUTING.md
View
@@ -1,11 +1,23 @@
-### Please read before contributing
+## Contributing to CanCanCan
-1) If you have any questions about CanCanCan, search the [Wiki](https://github.com/bryanrite/cancancan/wiki) or use [Stack Overflow](http://stackoverflow.com/questions/tagged/cancancan). Do not post questions here.
+### Reporting an Issue
-2) If you find a security bug, **DO NOT** submit an issue here. Please send an e-mail to [bryan@bryanrite.com](mailto:bryan@bryanrite.com) instead.
+1. If you have any questions about CanCanCan, search the [Wiki](https://github.com/bryanrite/cancancan/wiki), use [Stack Overflow](http://stackoverflow.com/questions/tagged/cancancan), or [our mailing list](https://groups.google.com/forum/#!forum/cancancan). Do not post questions here.
-3) Do a small search on the issues tracker before submitting your issue to see if it was already reported / fixed. In case it was not, create your report including Rails and CanCanCan versions. If you are getting exceptions, please include the full backtrace.
+1. If you find a security bug, **DO NOT** submit an issue here. Please send an e-mail to [bryan@bryanrite.com](mailto:bryan@bryanrite.com) instead.
+
+1. Do a small search on the issues tracker before submitting your issue to see if it was already reported / fixed.
+
+1. Create your report including Rails and CanCanCan versions. If you are getting exceptions, please include the full backtrace.
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.
+### Adding new Features or Bugfixes
+
+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`.
+
+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.
+
Thanks!
6 README.rdoc
View
@@ -161,11 +161,11 @@ If you have any issues with CanCan which you cannot find the solution to in the
Cancancan uses {appraisals}[https://github.com/thoughtbot/appraisal] to test the code base against multiple versions of rails, as well as the different model adapters.
-When first developing, you may need to run +bundle install+ and then +appraisal install+, to install the different sets.
+When first developing, you may need to run <tt>bundle install</tt> and then <tt>appraisal install</tt>, to install the different sets.
-You can then run all appraisal files (like CI does), with +appraisal rake+ or just run a specific set +appraisal rails_3.0 rake+.
+You can then run all appraisal files (like CI does), with <tt>appraisal rake</tt> or just run a specific set <tt>appraisal rails_3.0 rake</tt>.
-See the {spec/README}[https://github.com/bryanrite/cancancan/blob/master/spec/README.rdoc] for more information.
+See the {CONTRIBUTING}[https://github.com/CanCanCommunity/cancancan/blob/develop/CONTRIBUTING.md] and {spec/README}[https://github.com/bryanrite/cancancan/blob/master/spec/README.rdoc] for more information.
== Special Thanks
3  spec/README.rdoc
View
@@ -18,11 +18,10 @@ Or individual ones:
appraisal rails_3.0 rake
-A list of the test tests is in the +Appraisal+ file.
+A list of the tests is in the +Appraisal+ file.
The specs support Ruby 1.8.7+
== Model Adapters
The model adapter ENV setting has been removed and replaced with the +Appraisal+ file.
-
Please sign in to comment.
Something went wrong with that request. Please try again.