We love pull requests from everyone. Here are some ways you can contribute:
- By using alpha, beta, and prerelease versions
- By reporting bugs
- By suggesting new features
- By writing or editing documentation
- By writing specifications
- By writing code (no patch is too small: fix typos, add comments, etc.)
- By refactoring code
- By closing issues
- By reviewing patches
- We use the GitHub issue tracker to track bugs and features.
- Before submitting a bug report or feature request, check to ensure it hasn't already been submitted.
- When submitting a bug report, please include a Gist with a stack trace and any details necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.
- Issues with no response from the submitter will be closed after 30 days.
- Issues will be closed once they're assumed to be fixed or answered. If the maintainer is wrong, it can be opened again.
- If your issue is closed by mistake, please understand and explain the issue. We will happily reopen the issue.
- Fork the official repository.
- Create a topic branch.
- Implement your feature or bug fix.
- Add, commit, and push your changes.
- Submit a pull request.
- Please add tests if you changed code. Contributions without tests won't be accepted.
- If you're unsure how to add tests, submit a PR and leave a comment asking for help. We love to assist!
- Please don't update the Gem version.
Inspired by https://github.com/thoughtbot/factory_bot/blob/main/CONTRIBUTING.md