![]() Release notes of Wikimedia deployment branches of MediaWiki.The Git CLI uses the subject in: git shortlog, git log -oneline, git rebase -i, git show, etc.GitHub uses the subject in: commit history, commit subject.Gerrit uses the subject in: email notifications, IRC notifications, search results.That way, they can be universally selected, copied, or clicked. Instead, mention those in the body text, or footer meta-data. Therefore, do not mention Phabricator tasks, Git commits, or urls inside the subject line. This means URLs do not work, and selecting/copying of text often is not possible. Most programs we use that display Git commit, render the subject line as plain text. The most important information of the footer is the Change-Id (mandatory) and Bug.įormat " Bug" and " Change-Id" meta-data exactly like in the examples below, and place them together at the end of the body, after one empty line.įind more information on individual meta-data fields below.Īdditional information Subject If the change is justified by a discussion elsewhere or some external documentation, try to summarise the key point(s) in your commit message and refer to the URL as well. ![]() Don't use only a URL as the explanation for a change.commit 665661 is different than change 665661. This is because commit hashes are sometimes numbers only, e.g. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |