-
Notifications
You must be signed in to change notification settings - Fork 30
Git Flow
Ben Watson edited this page Jun 25, 2021
·
4 revisions
- 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.
- When ready, the contributor should submit a PR from their feature branch (either in this repo or their fork) to the
master
branch. When opening the PR, the user should fill out the body of the PR (which will become part of the changelog.txt file) and attach one of the PR labels starting withrelease
based on the type of change described below:- release/major - if the PR contains any breaking changes for the CLI
- release/minor - if the PR contains new features, but no breaking changes
- release/patch - if the PR changes any code that will be included when publishing to NPM, but has no new features and no breaking changes
- release/skip - if the PR only contains changes that do not affect the CLI, such as documentation or changes to Github Actions
- Another user should either approve the PR, reject the PR, or request changes
- Then, if the PR was approved, the contributor who submitted the PR should merge the PR and delete their feature branch. A Github Action will automatically update the necessary files, commit to master, and publish the update to NPM