@noaigniteCONTRIBUTING

Contributing

Thank you for helping out!

Environment

The project is dependent on Node v20.x.x in order to run in development. It is recommended to have nvm installed to conveniently manage your node versions between projects. Once you have it installed you can install the node version denoted in the .nvmrc file.

nvm use

Sending a Pull Request

  1. Install the dependencies with pnpm (yarn or npm aren’t supported):
pnpm install
  1. Create a new topic branch:
git checkout -b my-topic-branch
  1. Make changes, commit and push your branch:
git push

It is recommended to use conventional commits.

  1. Go to the repository and make a Pull Request.

Adding a changeset to your Pull Request

Not all Pull Requests need a changeset. Adding a changeset to your Pull Request will cause a version bump for the specified packages. If your changes should not result in a new version, mark your PR with an empty changeset. When creating a changeset, make sure to include the generated changeset in the same commit as the corresponding code changes.

Create a changeset:

pnpm changeset

Create an empty changeset:

pnpm changeset --empty

Where possible, please add tests for any changes you make. Tests can be run locally with pnpm test.

Get StartedREADME