Skip to content

Commit eb5cc36

Browse files
Apply suggestions from code review
Co-authored-by: Edan Bainglass <45081142+edan-bainglass@users.noreply.github.com>
1 parent 2704f0f commit eb5cc36

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

docs/source/dev.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,17 +41,16 @@ This will automatically add:
4141
2. The list of commits since the previous release, with links to them.
4242

4343
Sort the commit items into the correct subsection of the change log.
44-
Ideally, the main changes or new features are also described at the top of the change log message, providing code snippets where it's useful.
44+
Ideally, describe the main changes or new features at the top of the change log message, providing code snippets where it's useful.
4545

46-
Once you've prepared the release branch locally, commit and push it to Github:
46+
Once you've prepared the release branch locally, commit and push it to Github:
4747

4848
git commit -am '🚀 Release `v1.7.2`'
4949
git push -u origin release/1.7.2
5050

51-
Now that the release branch is ready, merge it into `main` via a pull request.
52-
Make sure the remote `release/1.7.2` branch is up to date by pushing the local changes, then go to Github and create a pull request to the `main` branch of the official repository.
51+
Now that the release branch is ready, push the local changes to the remote `release/1.7.2` branch, then go to Github and create a pull request to the `main` branch of the official repository.
5352

54-
After the pull request has been approved, merge the PR using the "Squash and Merge", and make sure the commit is simply named e.g. "🚀 Release `v1.7.2`".
53+
After the pull request has been approved, merge the PR using the **"Squash and Merge"**, and make sure the commit is simply named e.g. "🚀 Release `v1.7.2`".
5554

5655
Once this is complete, fetch all the changes locally, checkout the `main` branch and make sure it's up to date with the remote:
5756

0 commit comments

Comments
 (0)