Skip to content

Commit

Permalink
Improve contributing section
Browse files Browse the repository at this point in the history
  • Loading branch information
abelsoares committed Jun 13, 2016
1 parent 97c3848 commit 336619d
Showing 1 changed file with 28 additions and 2 deletions.
30 changes: 28 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,41 @@ bookshelf.Model.extend({

## Contributing

Feel free to fork this repository and submit pull requests. To run the tests, duplicate the *test/knexfile.js.dist* file, update it to your needs and run:
Contributions are welcome and greatly appreciated, so feel free to fork this repository and submit pull requests.

- **bookshelf-json-columns** supports PostgreSQL and SQLite3.
- You can find test suites for each of these database engines in the *test/postgres* and *test/sqlite* folders.

### Setting up

- Fork then clone the **bookshelf-json-columns** repository.
- Duplicate the *test/postgres/knexfile.js.dist* and *test/sqlite/knexfile.js.dist* files without the **.dist** extension and update it to your needs.
- Make sure all the tests pass:

```sh
$ npm test
```

### Linting

**bookshelf-json-columns** enforces linting using [ESLint](http://eslint.org/) with the [Seegno-flavored ESLint config](https://github.com/seegno/eslint-config-seegno). We recommend you to install an eslint plugin in your editor of choice, although you can run the linter anytime with:

```sh
$ eslint src/** test/**
```

### Pull Request

Please follow these advices to keep the pull request workflow simple and to increase the chances of having your PR merged:

- If you add or enhance functionality, an update of *README.md* usage section should be part of the PR.
- If your PR fixes a bug you should include tests that at least fails before your code changes and pass after.
- Keep your branch rebased and fix all conflicts before submitting.
- Make sure travis build status is ok.

## License

MIT
[MIT](https://opensource.org/licenses/MIT)

[coveralls-image]: https://img.shields.io/coveralls/seegno/bookshelf-json-columns/master.svg?style=flat-square
[coveralls-url]: https://coveralls.io/github/seegno/bookshelf-json-columns?branch=master
Expand Down

0 comments on commit 336619d

Please sign in to comment.