Skip to content

Latest commit

 

History

History
39 lines (29 loc) · 895 Bytes

CONTRIBUTING.md

File metadata and controls

39 lines (29 loc) · 895 Bytes

CONTRIBUTING

Contributions are welcome, and are accepted via pull requests. Please review these guidelines before submitting any pull requests.

For major changes, please open an issue first describing what you want to add/change.

Process

  1. Fork the project
  2. Create a new branch
  3. Code, test, commit and push
  4. Open a pull request detailing your changes

Guidelines

  • Please ensure the coding style running make lint.
  • Send a coherent commit history, making sure each individual commit in your pull request is meaningful.
  • You may need to rebase to avoid merge conflicts.
  • Please remember that we follow SemVer.

Setup

Clone your fork, then install the dev dependencies:

make install

Lint

Lint your code:

make lint

Tests

Run all tests:

make test