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

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

MyFirstContribution: add standalone section on cover letter

2022-05-13T01:09:59Z

An explanation of the purpose of the cover letter is included in the "Sending Patches with git send-email" / "Preparing Email" section but is missing from the "Sending Patches via GitGitGadget" section. Add a standalone section "The cover letter" under the "Getting Started: Anatomy of a Patch Series" header to explain what the cover letter is used for and to draft the cover letter of the 'psuh' topic used in the tutorial. For now we mostly copy content from the "Sending Patches with git send-email" section but do not adjust that section, nor the GGG section, to reference the new section. This is done in following commits. Also, adjust the "Preparing Email" Asciidoc anchor to avoid conflicts. Signed-off-by: Philippe Blain Signed-off-by: Junio C Hamano

MyFirstContribution: add "Anatomy of a Patch Series" section

2022-05-13T01:09:59Z

Before describing how to send patches to the mailing list either with GitGitGadget or 'git send-email', the MyFirstContribution tutorial includes a small "Getting Ready to Share" section where the two different methods are briefly introduced. Use this section to also describe what a patch series looks like once submitted, so that readers get an understanding of the end result before diving into how to accomplish that end result. Start by copying the "thread overview" section of a recent contribution from the public-inbox web UI and explaining how each commit is a separate mail, and point out the cover letter. Subsequent commits will move the existing description of the purpose of the cover letter from the 'git send-email' section to this "anatomy" section. Also, change the wording in the introductory paragraph to use "contributions" instead of "patches", since this makes more sense when talking about GitHub pull requests. Signed-off-by: Philippe Blain Signed-off-by: Junio C Hamano

Merge branch 'jc/tutorial-format-patch-base'

2021-11-29T23:41:46Z

Teach and encourage first-time contributors to this project to state the base commit when they submit their topic. * jc/tutorial-format-patch-base: MyFirstContribution: teach to use "format-patch --base=auto"

MyFirstContribution: teach to use "format-patch --base=auto"

2021-10-23T21:03:11Z

Let's encourage first-time contributors to tell us what commit they based their work on with the format-patch invocation. As the example already forks from origin/master and branch.autosetupmerge by default records the upstream when the psuh branch was created, we can use --base=auto for this. Also, mention that the range of commits can simply be given with `@{u}` if they are on the `psuh` branch already. As we are getting one more option on the command line, and spending one paragraph each to explain them, let's reformat that part of the description as a bulleted list. Helped-by: Bagas Sanjaya Signed-off-by: Junio C Hamano

MyFirstContribution: Document --range-diff option when writing v2

2021-09-22T21:25:05Z

In the "Sending v2" section, readers are directed to create v2 patches without using --range-diff. However, it is customary to include a range-diff against the v1 patches as a reviewer aid. Update the "Sending v2" section to suggest a simple workflow that uses the --range-diff option. Also include some explanation for -v2 and --range-diff to help the reader understand the importance. Signed-off-by: Glen Choo Signed-off-by: Junio C Hamano