delta/git.git/Documentation/SubmittingPatches, branch mk/diff-delta-avoid-large-offset

Merge branch 'rg/doc-submittingpatches-wordfix'

2017-05-04T07:26:46+00:00

* rg/doc-submittingpatches-wordfix:
  doc: update SubmittingPatches

doc: update SubmittingPatches

2017-05-01T00:08:10+00:00

-use US English spelling
-minor wording change for better readability

Helped-by: Stefan Beller 
Signed-off-by: René Genz 
Signed-off-by: Junio C Hamano

doc/SubmittingPatches: show how to get a CLI commit summary

2017-03-26T22:59:08+00:00

Amend the section which describes how to get a commit summary to show
how do to that with "git show", currently the documentation only shows
how to do that with gitk.

Signed-off-by: Ævar Arnfjörð Bjarmason 
Signed-off-by: Junio C Hamano

doc/SubmittingPatches: clarify the casing convention for "area: change..."

2017-03-21T19:00:43+00:00

Amend the section which describes how the first line of the subject
should look like to say that the ":" in "area: " shouldn't be treated
like a full stop for the purposes of letter casing.

Change the two subject examples to make this new paragraph clearer,
i.e. "unstar" is not a common word, and "git-cherry-pick.txt" is a
much longer string than "githooks.txt". Pick two recent commits from
git.git that fit better for the description.

Signed-off-by: Ævar Arnfjörð Bjarmason 
Signed-off-by: Junio C Hamano

doc: clarify distinction between sign-off and pgp-signing

2017-01-27T21:41:30+00:00

The documentation for submission discourages pgp-signing, but demands
a proper sign-off by contributors. However, when skimming the headings,
the wording of the section for sign-off could mistakenly be understood
as concerning pgp-signing. Thus, new contributors could oversee the
necessary sign-off.

This commit improves the wording such that the section about sign-off
cannot be misunderstood as pgp-signing. In addition, the paragraph about
pgp-signing is changed such that it avoids the impression that
pgp-signing could be relevant at later stages of the submission.

Signed-off-by: Cornelius Weig 
Helped-by: Philip Oakley 
Helped-by: Stefan Beller 
Signed-off-by: Junio C Hamano

SubmittingPatches: use gitk's "Copy commit summary" format

2016-08-26T22:58:10+00:00

Update the suggestion in 175d38ca ("SubmittingPatches: document how
to reference previous commits", 2016-07-28) on the format to refer
to a commit to match what gitk has been giving since last year with
its "Copy commit summary" command; also mention this as one of the
ways to obtain a commit reference in this format.

Signed-off-by: Beat Bolli 
Signed-off-by: Junio C Hamano

SubmittingPatches: document how to reference previous commits

2016-08-17T17:47:33+00:00

To reference previous commits people used to put just the
abbreviated SHA-1 into commit messages.  This is what has evolved as
a more stable format for referencing commits.  So lets document it
for everyone to look-up when needed.

Signed-off-by: Heiko Voigt 
Signed-off-by: Junio C Hamano

Documentation: add setup instructions for Travis CI

2016-05-02T18:31:44+00:00

Also change UK english "behaviour" to US english "behavior".

Signed-off-by: Lars Schneider 
Signed-off-by: Junio C Hamano

Merge branch 'jc/submitting-patches-mention-send-email'

2015-03-25T19:54:23+00:00

Recommend format-patch and send-email for those who want to submit
patches to this project.

* jc/submitting-patches-mention-send-email:
  SubmittingPatches: encourage users to use format-patch and send-email

SubmittingPatches: encourage users to use format-patch and send-email

2015-03-15T21:31:42+00:00

In step "(4) Sending your patches", we instruct users to do an
inline patch, avoid breaking whitespaces, avoid attachments, use
[PATCH v2] for second round, etc., all of which format-patch and
send-email combo know how to do well.

The need was identified by, and the text is based on the work by
Cody Taylor.

Suggested-by: Cody Taylor 
Signed-off-by: Junio C Hamano