- How to contribute code
- How to submit an issue
How to contribute code
1. Decide what to work on
- Check the open issues.
- View the project board.
- Check especially what's
up for grabs,
high priority, or
- Read some docs, like:
📖Frontend: Getting Started
Then, tell folks what you'll be working on, and:
2. FORK this repo
Everyone must follow the rules below (inspired by the C4.1 process) to submit code (documentation may be edited directly by maintainers):
- Always work in your own fork and submit pull requests (PRs) to
- Always add/update tests for any new/modified functionality. (
- Always make sure your PR passes all tests (
- Always ensure your PR adheres to the Contribution Policy described below.
3. Follow this Contribution Policy
This contribution policy will evolve over time. For now it is based on a slightly modified subset of C4.1.
Licensing and Ownership
- All contributions to the project source code ("patches" or "pull requests") SHALL use the same license as the project.
- All patches are owned by their authors. There SHALL NOT be any copyright assignment process.
- Each Contributor SHALL be responsible for identifying themselves in the project Contributor list.
Pull Request Requirements (
- A PR SHOULD be a minimal and accurate answer to exactly one identified and agreed problem.
- A PR SHOULD follow the boy scout rule: leave the code cleaner than you found it when the refactor effort is not too big.
- A PR SHALL NOT include non-trivial code from other projects unless the Contributor is the original author of that code.
- A PR MUST pass all tests on at least the principle target platform.
- A PR MUST include new tests for any new functionality introduced.
- A PR SHOULD avoid "callback-hell" style and instead prefer "async/await" style.
- A PR MUST follow the requirements spelled out in this project's Style Guide.