Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update contribution release guide #128

Merged
merged 1 commit into from
Jun 14, 2023
Merged

docs: update contribution release guide #128

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ People *love* thorough bug reports. I'm not even kidding.

## Write descriptive commit messages

Ensure you add an excellent descriptive commit message to this repository. A good guide can be found [here](https://www.conventionalcommits.org/en/v1.0.0/). Please check out the [commitizen](https://github.com/commitizen/cz-cli) npm package, as it is beneficial in helping you write good commit messages.
Ensure you add an excellent descriptive commit message to this repository. A good guide can be found [here](https://www.conventionalcommits.org/en/v1.0.0/). When writing commit messages, please follow the [conventional commits specifications](https://www.conventionalcommits.org/en/v1.0.0/). Additionally, you are recommended to check out the [commitizen](https://github.com/commitizen/cz-cli) npm package, as it is beneficial in helping you write good commit messages.

## Use a Consistent coding Style

Expand Down Expand Up @@ -77,13 +77,7 @@ The [Stable Gym](https://github.com/rickstaa/stable-gym) package also contains s

## Release guidelines

There are three ways to ensure a new release is created:

1. Create a new release using the GitHub draft release tool.
2. Create a new release using the GitHub release action. This action will be triggered when a pull request with a version label is merged into the main branch (i.e. `bump:patch`, `bump:minor` or `bump:major`).
3. Run the `npm run release` command locally. This command will create a new release and push it to the main branch.

Additionally, please use the [versioning guidelines specified at semver.org](https://semver.org/).
Releases are handled automatically by the [release-please-action](https://github.com/google-github-actions/release-please-action). This action will automatically create release pull requests based on the content of commit messages on the main branch. For this action to work, you must use the [conventional commits specifications](https://www.conventionalcommits.org/en/v1.0.0/) when writing commit messages.

## Documentation guidelines

Expand Down