Your contributions are most welcome! These guidelines will be useful for Issues and PR.
Basically, please report using the template provided. Of course, you may also write your own report.
The template contains a
- Bug report
- Feature request
and choose the one that best suits the issue you wish to submit.
Also, please help us by filling out the form as much as possible, as it will speed up the time it takes to fix bugs and add features.
Fork this repository and create a branch from the latest main branch.
Run yarn to install dependencies.
You can run the test as follows.
| common | watch |
|---|---|
yarn test |
yarn test:watch |
When committing, changed files are automatically linted and formatted, and commit messages are created interactively by git-cz.
(Attention: git commit will automatically run git-cz.)
The rules for doing so are as follows.
| type | description |
|---|---|
| feat | A new feature |
| fix | A bug fix |
| sec | A vulnerability fix |
| perf | A code change that improves performance |
| refactor | A code change that neither fixes a bug or adds a feature |
| docs | Documentation only changes |
| release | Create a release commit |
| style | Markup, white-space, formatting, missing semi-colons... |
| test | Adding missing tests |
| ci | CI related changes |
| chore | Build process or auxiliary tool changes |