Skip to content

Latest commit

 

History

History
27 lines (18 loc) · 925 Bytes

File metadata and controls

27 lines (18 loc) · 925 Bytes

Guidelines for contributing

1. Fork & Clone

Since you probably don't have rights to the main repo, you should Fork it (big button up top). After that, clone your fork locally and optionally add an upstream:

git remote add upstream git@github.com:DatabaseCleaner/database_cleaner.git

2. Make sure the tests run fine

  • bundle install
  • Copy spec/support/sample.config.yml to spec/support/config.yml and edit it
  • Run the tests with bundle exec rspec and bundle exec cucumber

Note that the Cucumber specs require redis to be running, you can either run it globally on your system or use the provided docker-compose.yml file and run docker compose up.

3. Prepare your contribution

This is all up to you but a few points should be kept in mind:

  • Please write tests for your contribution
  • Make sure that previous tests still pass
  • Push it to a branch of your fork
  • Submit a pull request