search

epiverse-trace / blueprints

Software development blueprints for epiverse-trace
https://epiverse-trace.github.io/blueprints
Other
4 stars 4 forks source link

Add co-authoring commits section to code-review #62

Closed joshwlambert closed 8 months ago

joshwlambert commented 8 months ago

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.

pratikunterwegs commented 8 months ago

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?

joshwlambert commented 8 months ago

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

pratikunterwegs commented 8 months ago

Ah I see thanks, sounds good.