Edit Tim Pope's commit guidelines for clarity #1486
Merged
Conversation
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
- Clarify that it's the end user that will get confused with rebasing when the body and summary of the commit message are mushed together. - Edit the line that links to the original Tim Pope blog post, stating that we adapted it. We're no longer fully quoting him. Fixes #696
ben
reviewed
Aug 16, 2020
Co-authored-by: Ben Straub <[email protected]>
Contributor
Author
|
I think this is ready for the final review, and merge afterwards. 😄 |
|
V |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Changes
Context
Fixes #696
@ben I'm not sure if editing the source text that Tim Pope created is the right thing to do here? Seeing as we quoting his words, and then edit them later... Should we use a footnote/callout instead? Or just leave it be and just close both this PR and the linked issue?
I noticed there might be two options to do this more cleanly, a callout
<1>or afootnote:[]. I do not know if those are supported within a[source, text]block?Source: Asciidoctor manual for callouts and for footnotes.