Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 1.18 KB

CONTRIBUTING.md

File metadata and controls

31 lines (20 loc) · 1.18 KB
Raw

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. Refer to SECURITY.md for instructions.

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 main 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.

  • Update the CHANGELOG. Don't forget to add your new changes to the CHANGELOG.