File: CONTRIBUTE.markdown

package info (click to toggle)
ruby-database-cleaner 1.7.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 756 kB
  • sloc: ruby: 4,852; makefile: 10; sh: 4
file content (28 lines) | stat: -rw-r--r-- 863 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# 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 `db/sample.config.yml` to `db/config.yml` and edit it
- Make sure to create the databases specified in `db/config.yml`
- 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