docs/development Key points: Referencing issues in commit messages #3210
Conversation
This file contains 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
This change was made to my last accepted commit, and looking back it's standard in a lot of commits, so it's clearly something developers should be doing normally. No changelog update because this is already covered by the tox-dev#3197 changelog going out in the next release.
gaborbernat
reviewed
Jan 29, 2024
| @@ -12,6 +12,8 @@ section. This section contains only highlights; it's not a substitute for readin | |||
|
|
|||
| - Lines wrapped at less than 120 characters. Lines should be wrapped at 120 characters, not the PEP-8 standard of 79. | |||
| - Variable names should be at least two characters long. | |||
| - If a commit references an issue, this should be noted in parentheses at the end of the summary line, e.g. | |||
There was a problem hiding this comment.
This is really optional, some people tend to do this but I'm not sure I want to make it a requirement.
There was a problem hiding this comment.
Ah. I added this because you were updating my commit messages to do this, so I thought it was required. (I'm also assuming that, since this is the "for experienced developers section," experienced developers will do what they consider the right thing anyway if they feel they need to violate these guidelines, explain it in the PR, and negotiate what needs to be done with you.)
So we can:
- Just drop this change if you're ok without mentioning the issue on the summary line (though I'd reckoned you were not), in which case you can just reject the PR.
- Mark this optional, in which case I'll update the text.
- Leave it as it is in this change if you'd prefer people do this unless they think they've got a good reason not to, in which case you can just merge the PR.
I'm good with any of the above options.
|
I'll close this as seems this has stalled. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This change was made to my last accepted commit, and looking back it's standard in a lot of commits, so it's clearly something developers should be doing normally.
No changelog update because this is already covered by the #3197 changelog going out in the next release.
tox -e fix)docs/changelogfolder