Skip to content

CONTRIBUTION.md

Latest commit

 

History

History
38 lines (26 loc) · 1.75 KB

CONTRIBUTION.md

File metadata and controls

38 lines (26 loc) · 1.75 KB

Contribution

Commits

We aim to follow the Conventional Commits format for our commits, but at the end, the PR title matters the most as we squash all commits into one when merging PRs.

Linting and formatting

We're using git hook to run linting and formatting before each commit. You can run them manually by running pnpm lint and pnpm format.

IDE support

If your IDE is showing error on commit like node: command not found, you can fix it by running the project from the terminal.

cd ./frontends
code .
# or
cursor .
# or wny other

Changelog preparation

In order to keep track of the changes inside project we do use changesets package to generate changelogs. After you created some changes follow these steps:

  1. run pnpm changeset
  2. pick packages inside which you made changes
  3. pick packages for major, minor or patch version bump depending on your changes
  4. write a short description of your changes
  5. there should be a new file inside .changeset folder, review it, add more instructions if needed (for example breaking changes upgrade steps) and commit it
  6. push your changes to the repository - PR is ready to be reviewed

Creating Pull Request

Conventional Pull Request title

We're using Conventional Commits to keep our commit messages consistent. However to avoid having too much noise, we're squashing all commits into one when merging PRs. That's why the PR title is the commit message for the whole PR. Please make sure to follow the Conventional Commits format when creating a PR title. We do have a GitHub Action that will check if the PR title is valid.