Skip to content

Latest commit

 

History

History
89 lines (60 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

89 lines (60 loc) · 1.71 KB
Raw

Contributing

Short Rules

  • MUST NOT commit to the main branch.
  • MUST NOT merge locally into the main branch. MUST use Pull Request.
  • MUST NOT use "merge commit" or "Rebase and merge". MUST use "Squash and merge".
  • Pull Request titles MUST comply with Conventional Commits spec.
  • git commit message SHOULD follow Conventional Commits spec.
  • If you make a fix that changes behavior (feature addition, bug fix, etc), you MUST add a test codes that fails before the fixes and succeeds after the fixes.

Developing

Brunch Workflow

We use GitHub Flow.

Versioning

We use Semantic Versioning.

Requirement

Setup

Note If Corepack is available in your development environment, do not forget to enable Corepack before running the pnpm command.

$ corepack enable
$ git clone https://github.com/sounisi5011/npm-packages.git
$ cd ./npm-packages/
$ pnpm install

Running linting/tests

Lint & Test

$ pnpm test

Lint

$ pnpm run lint

Test

$ pnpm run test-only

Format

$ pnpm run fmt
Format only *.json and *.yaml
$ pnpm run fmt:config
Format only package.json
$ pnpm run fmt:pkg
Format only *.js and *.ts
$ pnpm run fmt:xs