doc: contribute: distinguish renaming new versus old files #84177
+7
−2
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
Address a concern raised by @de-nordic in the review of commit 3756f59 ("doc: contribution guidelines: Clarify and extend") Signed-off-by: Marc Herbert <[email protected]>
nashif
requested changes
Jan 17, 2025
de-nordic
reviewed
Jan 18, 2025
There was a problem hiding this comment.
@marc-hb Thanks for bringing this up.
I think that this addition is a nod in direction of reviewers.
I had often had to review code/doc updates done via move-change and often had to download pr and pass file through a script to find me changes in moved, and often indented, block.
|
|
||
| * The history remains clean and easy to follow. | ||
| * Bisectability is preserved by eliminating redundant renaming or partial rewrites. | ||
|
|
||
| Note renaming and changing code *older* than the Pull Request is a different situation. To | ||
| help git rename detection heuristics, it's better to minimize changes to code that is being |
There was a problem hiding this comment.
Maybe just note that this helps reviewers rather than git.
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.
Address a concern raised by @de-nordic in the review of commit 3756f59 ("doc: contribution guidelines: Clarify and extend")