Writing Github Release Notes

To understand how you can write a Release Notes in Github, we can take a look at some examples.

• https://github.com/facebook/react/releases

Noticed those words with @ symbol and # symbol?

They are username and issue number or pull request number.

• @username

• #issueNumber or #pullRequestNumber

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 push

The #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

• https://github.com/nodejs/node/releases

The commit number can also be added to the Release Notes and clicking them will go to the commit.