diff --git a/docs/source/content/contributing.md b/docs/source/content/contributing.md index b26212e3b..dbf5f1073 100644 --- a/docs/source/content/contributing.md +++ b/docs/source/content/contributing.md @@ -219,19 +219,21 @@ In the release candidate branch: 5. Merge release candidate branch into `main` branch In the `main` branch: - -1. Run the [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator) tool locally with the following parameters: - ``` - github_changelog_generator -u imperialcollegelondon -p sharpy -t --future-release - ``` - -2. Push the changes to the `CHANGELOG.md` file -3. Create a release tag. IMPORTANT: ensure it is an *annotated* tag, otherwise the version and commit number in SHARPy will not display properly +1. Create a release tag. IMPORTANT: ensure it is an *annotated* tag, otherwise the version and commit number in SHARPy will not display properly ``` git tag -a git push origin --tags -f ``` where `` is something like `2.0`. + +2. Run the [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator) tool locally with the following parameters: + ``` + github_changelog_generator -u imperialcollegelondon -p sharpy -t --future-release + ``` + +3. Push the changes to the `CHANGELOG.md` file 4. Create the GitHub release, choosing the newly created tag from the dropdown menu. Do not create a tag from the dropdown menu directly because it will not be an annotated tag + +5. (Optional) Merge `main` branch back into `develop` branch