2014-11-21 06:52:05 -05:00
|
|
|
# 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`
|
2018-05-23 13:38:23 -04:00
|
|
|
- Copy `spec/support/sample.config.yml` to `spec/support/config.yml` and edit it
|
2014-11-21 06:52:05 -05:00
|
|
|
- Run the tests with `bundle exec rspec`
|
|
|
|
|
|
|
|
|
|
Note that if you don't have all the supported databases installed and running,
|
|
|
|
|
some tests will fail.
|
|
|
|
|
|
|
|
|
|
## 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
|
