Zandronum Chat on our Discord Server Get the latest version: 3.1
Source Code
My View | View Issues | Change Log | Roadmap | All Projects Issue Support Ranking | Rules | My Account
  

View Revisions: Issue #3321 [ All Revisions ] [ Back to Issue ]
Summary 0003321: Adopt a 50/72 and one-change-per-commit (merges) style for Mercurial commit messages
Revision 2017-10-30 02:19 by WubTheCaptain
Description I have found Doomseeker's current Mercurial commit logs difficult to use, due to practice of development/habit. The current structure of a commit message is a freeform text limited by a hyphen (-). This is my personal pet peeve.

The full story of changes is not currently told, and an unaware person reverting (undoing) one commit may accidentally create a side effect of reverting another change because multiple related or unrelated changes may appear in one commit.

I propose a new format to be adopted: A title of max. 50 characters on first line (title), an empty line, then a message explaining the change (what was changed in detail and why it was necessary) with lines wrapped at 72 characters.

A commit should change one important thing. If an implementation (e.g. a new feature) takes multiple sensible changes, instead of one big commit it should be multiple commits and merged with a merge commit. This way, the changes are easier to review, revert individually (an individual commit) or as a whole (reverting the merge commit) and test for bugs.

Ideally, this style should be documented in a file such as CONTRIBUTING in version control / source distribution root and enforced.
Revision 2017-10-30 02:17 by WubTheCaptain
Description I have found Doomseeker's current Mercurial commit logs difficult to use, due to practice of development/habit. The current structure of a commit message is a freeform text limited by a hyphen (-). This is my personal pet peeve.

The full story of changes is not currently told, and an unaware person reverting (undoing) one commit may accidentally create a side effect of reverting another change because multiple related or unrelated changes may appear in one commit.

I propose a new format to be adopted: A title 0000002:0000050 characters on first line (title), an empty line, then a message explaining the change (what was changed in detail and why it was necessary) with lines wrapped at 72 characters.

A commit should change one important thing. If an implementation (e.g. a new feature) takes multiple sensible changes, instead of one big commit it should be multiple commits and merged with a merge commit. This way, the changes are easier to review, revert individually (an individual commit) or as a whole (reverting the merge commit) and test for bugs.

Ideally, this style should be documented in a file such as CONTRIBUTING in version control / source distribution root and enforced.




Questions or other issues? Contact Us.

Links

Copyright © 2000 - 2024 MantisBT Team
Powered by Mantis Bugtracker