Skip to content

Latest commit

 

History

History
89 lines (60 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

89 lines (60 loc) · 2.61 KB
Raw

Contribution Guide

Thanks for your interest for the project.
This is a guide that how to contribute to this repository. These are mostly guidelines, not rules. If you have suggestions to make it better, please let me know via Pull requests or Issues.

Issues

If you have any problems, improvements, or questions, please send them to us via Issues.

Pull requests

Pull requests are always welcome.
When your code is pulled in, it will be covered by the MIT license.

The changelog will be generated using the title of the pull request. Keep the following in mind.

  • Please make only one change per request. For example, "add a new feature & fix a bug" is not allowed.
  • Please give your pull request a title that is as simple and easy to understand as possible.

Environment setup

Prepare the following tools.

  • yarn 1.22.10+ (You may also be able to use npm. I haven't tried it.)

Install the yarn package.

yarn install

Build

Run this command.

yarn run all

Styleguides

Code

All JavaScript code is linted with Prettier.
Please run below command before commiting to check code styles.

yarn run format-check

Git Commit Messages

The commit message is set based on "Conventional Commits".

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]
<type>[optional scope]: <description>
  │          │               │
  │          │               └─⫸ Description in present tense. Not capitalized. No period at the end.
  │          │
  │          └─⫸ (Currently omitted.)
  │
  └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test

Type

Must be one of the following:

  • build: Changes that affect the build system or external dependencies. (example scopes: yarn)
  • ci: Changes to our CI configuration files and scripts. (example scopes: action)
  • docs: Documentation only changes.
  • feat: A new feature.
  • fix: A bug fix.
  • perf: A code change that improves performance.
  • refactor: A code change that neither fixes a bug nor adds a feature.
  • test: Adding missing tests or correcting existing tests.