Skip to content

Latest commit

 

History

History
57 lines (42 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

57 lines (42 loc) · 2.64 KB
Raw

Table of Contents generated with DocToc

How to contribute:

Bug reports / Issues

  • Is something broken or not working as expected? Check for an existing issue or create a new one
  • IMPORTANT: Include the version of the gem, if you've install from git, what Ruby and Rails you are running, etc.

Code

  1. Fork and clone the repo
  2. Install the gem dependencies: bundle install
  3. Make the changes you want and back them up with tests.
  1. Update the CHANGELOG.md file with your changes and give yourself credit
  2. Commit and create a pull request with details as to what has been changed and why
  • Use well-described, small (atomic) commits.
  • Include links to any relevant github issues.
  • Don't change the VERSION file.
  1. Extra Credit: Confirm it runs and tests pass on the rubies specified in the Github Actions config. I will otherwise confirm it runs on these.

How I handle pull requests:

  • If the tests pass and the pull request looks good, I will merge it.
  • If the pull request needs to be changed,
    • you can change it by updating the branch you generated the pull request from
      • either by adding more commits, or
      • by force pushing to it
    • I can make any changes myself and manually merge the code in.

Commit Messages

About Pull Requests (PR's)

Documentation

  • Update the wiki