1703039 - Warn against `hg commit --amend -m` in the contribution docs

Status: RESOLVED FIXED

(Developer Infrastructure :: Source Documentation, enhancement)

Description

[Matthew Gaudet (he/him) [:mgaudet]]

See Bug 1703032 for a description of the thing we're trying to avoid;

Comment 1

[Matthew Gaudet (he/him) [:mgaudet]]

Attachment: Bug 1703039 - Warn against `hg commit --amend -m` in the contribution docs r?#firefox-source-docs-reviewers

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/ca08f26c6106
Warn against `hg commit --amend -m` in the contribution docs r=firefox-source-docs-reviewers,sylvestre,championshuttler

Comment 3

[Andrew Halberstadt [:ahal]]

Looks like I was too late to the review, but hg amend or git commit --amend -CHEAD are alternatives that re-use the full commit message.

Comment 4

[Shivam Singhal [ :championshuttler ]]

I was also thinking why dont people use directly hg commit --amend --no-edit, I use this everytime I make changes to exisiting revision or their usecase is different? Can you confirm :mgaudet

Comment 5

[Matthew Gaudet (he/him) [:mgaudet]]

So the specific case I see is this: A new contributor is asked to change their commit message; the bring knowledge from Git or GitHub like workflows, and just go hg commit --amend -m "Bug XYZ - Updated Message r?reviewer"; but as hinted, this then blows up. This really is the direct use case where changing the commit message is in fact part of the goal, to your point about why not --no-edit

Comment 6

[Atila Butkovits]

https://hg.mozilla.org/mozilla-central/rev/ca08f26c6106