Add co-authoring commits section to code-review #62
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
Bisaloo
reviewed
Jan 12, 2024
Co-authored-by: Hugo Gruson <[email protected]>
|
Only seeing this now as I've been away. I'm not sure I understand the use-case for the procedure decribed here. In reviews, accepted reviewer suggestions such as typo fixes are automatically co-authored commits, and any larger contributions are typically as PRs which also credit authors. Would it help to add to this section to say when manual crediting is needed - is there a common case I'm overlooking? |
|
Agreed that in most cases, co-authorship is automatic by GitHub, however, when using suggestions in another PR the manual co-authorship is required: the use-case is outlined in Blueprints here: https://github.com/epiverse-trace/blueprints/blob/main/code-review.qmd#L32 |
|
Ah I see thanks, sounds good. |
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 PR adds a section detailing how to give recognition to collaborators through co-authoring commits. It is similar to
the As commit co-authors section in the Roles in package DESCRIPTION page, but the new additions give more details on some of the technical aspects of how to co-author commits.
This is information I've compiled that has helped me when suggestions are made in a PR but the changes are made on a different branch.