We love pull requests from everyone. By participating in this project, you agree to abide by the code of conduct.
Here are some ways you can contribute:
- by reporting bugs
- by writing or editing documentation
- by writing specifications
- by writing code ( no patch is too small : fix typos, add comments, clean up inconsistent whitespace )
- 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 make sure it hasn't already been submitted. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be 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.
- Fork the repository.
- Create a topic branch.
- Implement your feature or bug fix.
- Add, commit, and push your changes.
- Please add tests if you changed code. Contributions without tests won't be accepted.
- Please don't update the Gem version.
- Submit a pull request.
bundle install
bundle exec rspec
To run an individual rspec test, you can provide a path and line number:
bundle exec rspec spec/path/to/spec.rb:123
Use rubocop to automatically format your code:
bundle exec rubocop -c .rubocop.yml -A
Inspired by https://github.com/thoughtbot/factory_bot/blob/main/CONTRIBUTING.md