We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
We use Github Flow
Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:
- Fork the repo and create your branch from
master. The convention is[type]/[brief description]e.g.feature/add-templates. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation (e.g. CLI options).
- Ensure the test suite passes.
- Make sure your code lints.
- Submit that pull request!
We use GitHub issues to track public bugs. Report a bug by opening a new issue.
The project uses ESLint with the following plugins:
@typescript-eslint/eslint-recommended@typescript-eslint/recommendedprettier/recommended
If you're using VS Code please install the ESLint extension.
By contributing, you agree that your contributions will be licensed under its MIT License.