Skip to content

Commit 6cc1374

Browse files
committed
Remove period from "Update draft release notes..." commit message
The first line of a commit message should not have a period (`.`) I am not aware of any official Git documentation for the statement above. However, it has been a convention in all the projects and companies I worked on. The style is also present in the example commit message from the official Git book. See https://git-scm.com/docs/MyFirstContribution#:~:text=You%20will%20be%20presented%20with%20your,A%20U%20Thor%20%3Cauthor%40example.com%3E The style is also used in other sources, such as: - https://commit.style/ - https://www.gitkraken.com/learn/git/best-practices/git-commit-message#using-imperative-verb-form - https://thoughtbot.com/blog/5-useful-tips-for-a-better-commit-message One could argue that the 50 to 72 character length and the period omission were characters economy constraints from back in the day of small screens and text-only interfaces. While that is true, I find the are many benefits in forcing oneself to be concise in the commit title/summary. As for short line length, it works well for people like me, who use big font sizes because their eyes strain otherwise. But aside from all the justifications above, having commit message titles without a period is the existing convention in this repo, which make this change a no brainer.
1 parent 71095be commit 6cc1374

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

lib/fastlane/plugin/wpmreleasetoolkit/actions/common/extract_release_notes_for_version_action.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ def self.extract_notes(release_notes_file_path, version)
4141

4242
def self.check_and_commit_extracted_notes_file(file_path, version)
4343
Action.sh("git add #{file_path}")
44-
Action.sh("git diff-index --quiet HEAD || git commit -m \"Update draft release notes for #{version}.\"")
44+
Action.sh("git diff-index --quiet HEAD || git commit -m \"Update draft release notes for #{version}\"")
4545
end
4646

4747
def self.description

0 commit comments

Comments
 (0)