Contributing

Thank you for considering helping out!

Looking to update information or feature your project? Feel free to make the change yourself. You're in the right place to get started.

Bugs & Enhancements

We are using Github Issues to track public bugs & enhancements. Before filing an issue, we would recommend to try to find known issues first.

When filing an issue, to help us understand it clearly at an early time, please make sure follow the issue template and provide enough information.

You are recommended to work your pull requests with a Github Issue (either an existing issue or filing a new one).

It is our honor to have your first pull request, please see the video series or the awesome article to get started.

There might be some delay because we are also maintaining an internal version that used at FreeWheel. We will do best to update your pull requests.

Please see the following workflow before sending your pull request:

Fork the repository from master branch.
Install yarn and run yarn in the project root.
Add your code and related test as well.
Make sure all tests pass using yarn test. Please be aware that your commit would fail if it contains linting failures, we have added the hook to guarantee the styles.