Skip to content
This repository has been archived by the owner on Aug 17, 2021. It is now read-only.

Latest commit

 

History

History
33 lines (20 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

33 lines (20 loc) · 1.41 KB

Contributing

We love contributions. To get started contributing you might need:

Once you know how to create a pull request and have an issue to work on, just post a comment saying you will work on it. If you end up not being able to complete the task, please post another comment so others can pick it up.

Issues are also welcome, failing tests are even more welcome.

Contribution Guidelines

  • Try to use feature branches rather than developing on master
  • Please include tests covering the change
  • The docs are now stored in the repository under the Docs folder, please include documentation updates with your PR

Writing Tests

1. Find appropriate fixture

Find where your issue would logically sit, i.e. find the class closest to your issue.

2. Create a test method

We are currently using jest, so just create a descriptive test method.

3. Submit a pull request with the failing test

Even better include the fix, but a failing test is a great start.