Contributing

July 4, 2020 ยท View on GitHub

Thanks for taking the time to submit a pull request! These are the few guidelines to keep things coherent.

Fork the project and clone.

Create your feature branch:

git checkout -b features/xyz

Set up your machine. I recommend using Nix:

nix-shell
bundle install

Add your code and tests and check it passes:

bundle exec rspec

Although not required, try to adhere to Rubocop's checks:

bundle exec rubocop

Push your branch and submit a Pull Request.

Add a description of your proposed changes and why they are needed.

I'll review it as soon as I can.