Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

47 lines (31 loc) · 1.59 KB

Contributing

Your first contribution

Setting up the repository

  1. Fork this repository
  2. Create a new feature branch
git checkout -b my-feature-branch

Setting up a development environment

  1. Ensure that you have Node.js installed on your machine (you can use fnm or nvm to easily manage versions)
  2. Install the dependencies with pnpm ⚠️ yarn or npm aren't supported ⚠️
  • You can check the packageManager field of package.json to know what version of pnpm to install
pnpm install
  1. Run tests to ensure your project is in a good state
pnpm test

Making your changes

  1. Make whatever code changes you need
  2. Add or update tests coverage whenever possible

Verifying

  1. Run the tests pnpm run test
  2. View the changes in the demo site locally pnpm run dev
  3. Ensure that the project builds properly pnpm run tsc

Opening a pull request

  1. Once your branch is ready, and it contains bugfixes, documentation improvements or features, run pnpm changeset add to add a changeset file
    • There you can compose the markdown entry describing your changes that will be published in CHANGELOG.md
  2. Push your changes to your feature branch
  3. Open a pull request from your fork to the original repository in the Github UI or CLI