forked from DatabaseCleaner/database_cleaner
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add first version of CONTRIBUTE.markdown [ci skip]
- Loading branch information
Showing
1 changed file
with
28 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,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 [email protected]: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 |