Writing Github Release Notes
- Siah Peih Wee
- Aug 1, 2022
- 1 min read
Updated: Nov 8, 2022
To understand how you can write a Release Notes in Github, we can take a look at some examples.
Noticed those words with @ symbol and # symbol?
They are username and issue number or pull request number.
@username
When you mouse over them, you will see the following
Username
Issue Number or Pull Request Number
To get your own username is easy, the issue number can be gotten when you create a new Issue.
Once you click new for Issues or Pull Request, you will give the title and comment
Once you submit, you will see the issue number, similar for pull request.
Now you will see the hastag number.
So when you git commit, you will do something like this.
git add .
git commit -m "Adding Express Routes #5"
git pushThe #5 will be clickable when you see the commit. And below is an example how the commit will be log in the issue.
Next we look at another example
The commit number can also be added to the Release Notes and clicking them will go to the commit.
Your blog on “Writing GitHub Release Notes” provides clear and practical guidance for developers. I really appreciate how you highlighted the importance of structured documentation and version transparency. Using dissertation writing services has taught me the value of clarity and precision in technical writing, much like what’s required in professional release notes. The step-by-step approach you shared makes it easier for teams to maintain consistency across updates. It’s an excellent resource for developers aiming to improve their communication and project management practices.