git/Documentation/SubmittingPatches, branch gitk-resize-error

Merge branch 'jc/doc-submitting-patches-choice-of-base'

2022-01-10T19:52:55Z

Extend the guidance to choose the base commit to build your work on, and hint/nudge contributors to read others' changes. * jc/doc-submitting-patches-choice-of-base: SubmittingPatchs: clarify choice of base and testing

SubmittingPatchs: clarify choice of base and testing

2021-12-30T22:30:54Z

We encourage identifying what, among many topics on `next`, exact topics a new work depends on, instead of building directly on `next`. Let's clarify this in the documentation. Developers should know what they are building on top of, and be aware of which part of the system is currently being worked on. Encouraging them to make trial merges to `next` and `seen` themselves will incentivize them to read others' changes and understand them, eventually helping the developers to coordinate among themselves and reviewing each others' changes. Signed-off-by: Junio C Hamano

SubmittingPatches: fix Asciidoc syntax in "GitHub CI" section

2021-11-14T07:41:54Z

A superfluous ']' was added to the title of the GitHub CI section in f003a91f5c (SubmittingPatches: replace discussion of Travis with GitHub Actions, 2021-07-22). Remove it. While at it, format the URL for a GitHub user's workflow runs of Git between backticks, since if not Asciidoc formats only the first part, "https://github.com/ Signed-off-by: Junio C Hamano

SubmittingPatches: replace discussion of Travis with GitHub Actions

2021-07-22T19:53:14Z

Replace the discussion of Travis CI added in 0e5d028a7a0 (Documentation: add setup instructions for Travis CI, 2016-05-02) with something that covers the GitHub Actions added in 889cacb6897 (ci: configure GitHub Actions for CI/PR, 2020-04-11). The setup is trivial compared to using Travis, and it even works on Windows (that "hopefully soon" comment was probably out-of-date on Travis as well). Signed-off-by: Ævar Arnfjörð Bjarmason Signed-off-by: Junio C Hamano

SubmittingPatches: move discussion of Signed-off-by above "send"

2021-07-22T19:53:14Z

Move the section discussing the addition of a SOB trailer above the section that discusses generating the patch itself. This makes sense as we don't want someone to go through the process of "git format-patch", only to realize late that they should have used "git commit -s" or equivalent. This is a move-only change, no lines here are being altered, only moved around. Signed-off-by: Ævar Arnfjörð Bjarmason Signed-off-by: Junio C Hamano

Merge branch 'ds/gender-neutral-doc'

2021-07-17T00:42:53Z

Update the documentation not to assume users are of certain gender and adds to guidelines to do so. * ds/gender-neutral-doc: *: fix typos comments: avoid using the gender of our users doc: avoid using the gender of other people

doc: avoid using the gender of other people

2021-06-16T02:25:09Z

Using gendered pronouns for an anonymous person applies a gender where none is known and further excludes readers who do not use gendered pronouns. Avoid such examples in the documentation by using "they" or passive voice to avoid the need for a pronoun. Inspired-by: Derrick Stolee Signed-off-by: Felipe Contreras Signed-off-by: Derrick Stolee Signed-off-by: Junio C Hamano

doc: clarify "do not capitalize the first word" rule

2021-04-15T06:41:00Z

The same "do not capitalize the first word" rule is applied to both our patch titles and error messages, but the existing description was fuzzy in two aspects. * For error messages, it was not said that this was only about the first word that begins the sentence. * For both, it was not clear when a capital letter there was not an error. We avoid capitalizing the first word when the only reason you would capitalize it is because it happens to be the first word in the sentence. If a proper noun, which is usually spelled in capital letters, happens to come at the beginning of the sentence, it should be kept in capital letters. Signed-off-by: Junio C Hamano

SubmittingPatches: tighten wording on "sign-off" procedure

2021-01-07T23:41:36Z

The text says "if you can certify DCO then you add a Signed-off-by trailer". But it does not say anything about people who cannot or do not want to certify. A natural reading may be that if you do not certify, you must not add the trailer, but it shouldn't hurt to be overly explicit. Signed-off-by: Junio C Hamano

Merge branch 'jc/doc-final-resend'

2020-11-02T21:17:47Z

Update developer doc. * jc/doc-final-resend: SubmittingPatches: clarify the purpose of the final resend