Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

47 lines (32 loc) · 1.75 KB

Contributing

Your contributions are most welcome! These guidelines will be useful for Issues and PR.

Issue

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.

Pull Request

Fork this repository and create a branch from the latest main branch.

Setup

Run npm i to install dependencies.

Commit

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