git/Documentation/MyFirstContribution.txt, branch v2.42.2

Merge branch 'jc/doc-sent-patch-now-what'

2023-08-04T17:52:31Z

Process document update. * jc/doc-sent-patch-now-what: MyFirstContribution: refrain from self-iterating too much

MyFirstContribution: refrain from self-iterating too much

2023-07-28T00:44:07Z

Finding mistakes in and improving your own patches is a good idea, but doing so too quickly is being inconsiderate to reviewers who have just seen the initial iteration and taking their time to review it. Encourage new developers to perform such a self review before they send out their patches, not after. After sending a patch that they immediately found mistakes in, they are welcome to comment on them, mentioning what and how they plan to improve them in an updated version, before sending out their updates. Helped-by: Torsten Bögershausen Helped-by: Linus Arver Signed-off-by: Junio C Hamano

Merge branch 'la/mfc-markup-fix'

2023-04-18T01:05:12Z

Documentation mark-up fix. * la/mfc-markup-fix: MyFirstContribution: render literal *

MyFirstContribution: render literal *

2023-04-06T22:03:18Z

The HTML version of MyFirstContribution [1] does not render the asterisks (*) meant to be typed in as glob patterns by the user, because they are being interpreted as bold text delimiters. [1]: Search for "pattern" in https://git-scm.com/docs/MyFirstContribution#v2-git-send-email Signed-off-by: Linus Arver Acked-by: Taylor Blau Signed-off-by: Junio C Hamano

e-mail workflow: Message-ID is spelled with ID in both capital letters

2023-04-03T15:55:43Z

We used to write "Message-Id:" and "Message-ID:" pretty much interchangeably, and the header name is defined to be case insensitive by the RFCs, but the canonical form "Message-ID:" is used throughout the RFC documents, so let's imitate it ourselves. Signed-off-by: Junio C Hamano Reviewed-by: Elijah Newren

Documentation: fix typo

2022-11-14T23:14:58Z

Signed-off-by: Vlad-Stefan Harbuz Signed-off-by: Taylor Blau

Documentation: clean up a few misspelled word typos

2022-09-21T17:28:35Z

Used GNU "aspell check " to review various documentation files with the default aspell dictionary. Ignored false-positives between american and british english. Signed-off-by: Jacob Stopak Reviewed-by: Eric Sunshine Signed-off-by: Junio C Hamano

MyFirstContribution: drop PR description for GGG single-patch contributions

2022-05-13T01:10:00Z

By default, GitHub prefills the PR description using the commit message for single-commit PRs. This results in a duplicate commit message below the three-dash line if the contributor does not empty out the PR description before submitting, which adds noise for reviewers. Add a note to that effect in MyFirstContribution.txt. This partly addresses: https://github.com/gitgitgadget/gitgitgadget/issues/340 Signed-off-by: Philippe Blain Signed-off-by: Junio C Hamano

MyFirstContribution: reference "The cover letter" in GitGitGadget section

2022-05-13T01:10:00Z

The "Sending Patches via GitGitGadget" section mentions that the PR title and description will be used as the cover letter, but does not explain what is a cover letter or what should be included in it. Refer readers to the new "The cover letter" section added in a previous commit. Signed-off-by: Philippe Blain Signed-off-by: Junio C Hamano

MyFirstContribution: reference "The cover letter" in "Preparing Email"

2022-05-13T01:09:59Z

The previous commit added a standalone section on the purpose of the cover letter, drawing inspiration from the existing content of the "Preparing Email" section. Adjust "Preparing Email" to reference "The cover letter", to avoid content duplication. Also, use the imperative mode for the cover letter subject, as is done in "The cover letter". Signed-off-by: Philippe Blain Signed-off-by: Junio C Hamano