Github is used to host code, track issues and feature requests, as well as accept pull requests.
This project uses Volta to manage Node.js version. It is recommended to install it before starting development.
Github flow is used as a development process. This means that all changes are done by creating pull requests. Bringing a code change to this project should be executed as follows:
- Fork this repository.
- Make your changes. Do not forget about tests.
- Squash your changes to single commit. Write a concise commit message in imperative mode as described here.
- Rebase your changes to latest
main. - Create a pull request.
Pull requests are very welcome. However, if you want to add a new feature, please discuss your ideas first using Github issues.
When you submit code changes, your submissions are understood to be under the same MIT License that covers the project.