Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

71 lines (51 loc) · 2.08 KB

Contributing

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

Submitting an Issue

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.

Submitting a Pull Request

  1. Fork the repository.
  2. Create a topic branch.
  3. Implement your feature or bug fix.
  4. Add, commit, and push your changes.
  5. Please add tests if you changed code. Contributions without tests won't be accepted.
  6. Please don't update the Gem version.
  7. Submit a pull request.

Setting up

bundle install

Running the test suite

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

Formatting

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