Skip to content

Latest commit

 

History

History
80 lines (51 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

80 lines (51 loc) · 1.6 KB

Contributing guide

Pull requests

  • Consider opening an issue before submitting a pull-request to avoid unnecessary work
  • Ensure pull request titles adhere to the Conventional Commits specification

Release

The module is released automatically from the main and next branches using semantic-release-action. Version bumps and change logs are generated from the commit messages.

Preview release

If you would like to preview the release from a given branch, and...

  • You have push access to the repository
  • The branch exists in GitHub

...you can preview the next release version and changelog using:

pnpm run preview-release

Development setup

After cloning the repository, install the project's dependencies and run the validate script to run all checks and tests to verify your setup.

pnpm install
pnpm validate

Lint and format

Run auto-formatting to ensure any changes adhere to the code style of the repository:

pnpm -r fmt

To run lint and format checks without making any changes:

pnpm -r fmt.check

Test

Run unit tests once:

pnpm -r test

Docs

Use the toc script to ensure the README's table of contents is up to date:

pnpm toc

Use contributors:add to add a contributor to the README:

pnpm contributors:add

Use contributors:generate to ensure the README's contributor list is up to date:

pnpm contributors:generate