docs: clarify CC trailer placement and PR description usage - #33
Open
ptarjan wants to merge 1 commit into
Open
Conversation
新建 GitGitGadget users sometimes put CC: trailers in their commit messages (where they are ignored) instead of in the Pull Request description (where GitGitGadget reads them). They also sometimes duplicate the commit message in the PR description, not realizing that the PR description appears below the three-dash line in the emailed patch. Add two bullet points to the usage instructions to help avoid these common mistakes. Suggested-by: Junio C Hamano <gitster@pobox.com> Signed-off-by: Paul Tarjan <github@paulisageek.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
注册 for free
to join this conversation on GitHub.
Already have an account?
登录 to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
新建 GitGitGadget users sometimes put CC: trailers in their commit messages (where they are ignored) instead of in the Pull Request description (where GitGitGadget reads them). They also sometimes duplicate the commit message in the PR description, not realizing that it appears below the three-dash line in the emailed patch.
Add two bullet points to the usage instructions to help avoid these common mistakes.
Prompted by Junio's review at https://lore.kernel.org/git/xmqqikbb8pbd.fsf@gitster.g