Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 1.16 KB
Raw

CONTRIBUTION GUIDELINES

Contributions are welcome and will be fully credited.

We accept contributions via pull requests on GitHub. Please review these guidelines before continuing.

Guidelines

  • Please follow the PSR-12 Coding Style Guide, enforced by StyleCI.
  • Ensure that the current tests pass, and if you've added something new, add the tests where relevant.
  • Send a coherent commit history, making sure each commit in your pull request is meaningful.
  • You may need to rebase to avoid merge conflicts.
  • If you are changing or adding to the behaviour or public API, you may need to update the docs.
  • Please remember that we follow Semantic Versioning.

Running Tests

First, install the dependencies:

$ make install

Then run the test suite and static analyzers:

$ make test
  • The tests will be automatically run by GitHub Actions against pull requests.
  • We also have StyleCI set up to automatically fix any code style issues.