Skip to content
This repository has been archived by the owner on Sep 4, 2024. It is now read-only.

Git Flow

ntangy edited this page Jan 12, 2021 · 3 revisions
  1. All new work should be done in a new feature branch either in this repo or in a contributor's personal fork of this repo.
  2. When ready, the contributor should submit a PR from their feature branch (either in this repo or their fork) to the develop branch, which then must pass all checks
  3. Another user should either approve the PR, reject the PR, or request changes
  4. Then, if the PR was approved, the contributor who submitted the PR should
    1. Merge the PR to the develop branch
    2. Run npm version <type> -m <description> where <type> is either "major", "minor", or "patch" and <description> is a brief description of the changes in the release. This will bump the version in package.json, commit the change, and tag the commit with the version number and description
    3. Push the new tag/commit to this repo with git push origin develop --tags
    4. Create a PR from develop to master
    5. Merge the PR to master
    6. Draft a new release in the Release tab in Github (with the 'v' prefix)
    7. Run npm publish on the newly updated master branch (EDIT 1/12/2021: A new Github Action workflow has been added for automatically running npm publish after a new release has been created on Github. This step will not be needed unless the workflow fails)
Clone this wiki locally