Thank you for contributing! We ❤️ pull requests from everyone.
We have a few technical guidelines to follow:
- Open an issue to discuss a new feature.
- Write tests.
- Make sure the entire test suite passes locally and on CI.
- Update your code according to
rubocop
preferences. - Open a pull request.
- Participate in the reviews on the pull request.
For pure documentation changes, please add [ci skip]
to your commit message,
to prevent CI server from needless 🏃.
After cloning this repository, run the setup script:
bin/setup
Prepare your ENV
variables accordingly with .env.sample
.
Set up your development environment as per previous section.
Run bin/rspec
to execute the full test suite.
Run style checks with bundle exec rubocop -DR
If you submit a contribution to this application's source code, you hereby grant it under MIT LICENSE. See LICENSE.