Skip to content

Latest commit

 

History

History
48 lines (28 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

48 lines (28 loc) · 1.61 KB
Raw

Contributing

Thanks for your interest in contributing to this project!

Pull requests are very welcome to either fix existing bugs, add new features, or improve the code in general. Before submitting a pull request, please consider filing an issue to discuss the change's details.

Bug Reports

  1. Please search for similar issues before as there is a chance that someone might have reported it already.

  2. Provide a demo of the bug in isolation if possible (e.g., codesandbox.io); otherwise, try to be as detailed as possible in the description.

Feature Requests

Feature requests, improvements, and new suggestions are also always welcome, but please take a moment to find out whether your idea fits within the scope of this project or not.

Pull Requests

  1. Fork the repository.

  2. If you are adding new functionality, or fixing a bug, provide tests with code coverage of preferably 100%.

  3. Push the changes to your fork and submit a pull request!

Development

Once you have forked the project and checked it out locally, create a new branch from master and start developing!

Linting

You can run the linting tools with the following command:

yarn lint

Tests

Make sure that all tests are passing and that the code coverage is close to 100%.

yarn test

For End-to-End tests, please run the following command:

yarn test:e2e