To request a feature or report a bug, open an issue with the appropriate template. Please make sure to fill out all of the template details so that the feature request or bug report can be properly evaluated and triaged.
We do all of our work in branches. If you are starting work on a new feature or bug fix, create a new branch from dev:
git checkout dev
git checkout -b your-branch-nameGive your branch a descriptive name:
- For a new feature, call it
feat/description-of-feature - For a bug fix, call it
fix/description-of-bug
When committing your changes, use Conventional Commits. Your commits will be automatically linted; you must address any linting errors before submitting a pull request.
When your work is complete, open a pull request against the dev branch:
- The title of the pull request is in the format of
<type>: <description> (resolves <issue-id>)- For example, for a new feature that resolves the issue id #1, the title is
feat: description of the feature (resolves #1).This makes sure the issue id(s) is included in the commit history for easy access in the future.
- For example, for a new feature that resolves the issue id #1, the title is
- Please make sure to fill out the pull request template.
We merge all pull requests using squash commits.
Issues and their corresponding pull requests will be assigned to a milestone by the development team. Once all of the issues in a given milestone have been resolved, the development team will close the milestone and merge the dev branch into main. A release will then be tagged and a changelog generated, as follows:
- For patch releases, you can tag the release and generate a changelog by
running
npm run release:patch - For minor releases, you can tag the release and generate a changelog by
running
npm run release:minor - For major releases, you can tag the release and generate a changelog by
running
npm run release:major
Only at this point will the changes in that release be deployed to the production site.