Skip to content

DOC Note on commit co-authorship when merging PRs #16550

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 26, 2020

Conversation

rth
Copy link
Member

@rth rth commented Feb 26, 2020

A short note to raise awareness of @scikit-learn/core-devs that multiple co-authors can be attributed in git when merging PRs. The Co-authored-by tag pre-filled by Github needs to be kept in the detailed description for it to happen.

When to give co-authorship is left it maintainers appreciation, but I think there are at least the following cases where it could make sense to reflect co-authorship in git blame,

  • the what's new has multiple authors
  • stalled PR continued in another PR: first author should get co-authorship
  • stalled (and typically minor) PR fixed by a maintainer by pushing directly without creating a new PR.

Note that Github already does this by default, unless ones removes the detailed commit description when merging PRs.

Co-Authored-By: Joel Nothman <joel.nothman@gmail.com>
@jnothman jnothman merged commit 54cbf42 into scikit-learn:master Feb 26, 2020
@jnothman
Copy link
Member

Thanks @rth

@rth rth deleted the merging-insructions branch February 26, 2020 13:07
panpiort8 pushed a commit to panpiort8/scikit-learn that referenced this pull request Mar 3, 2020
gio8tisu pushed a commit to gio8tisu/scikit-learn that referenced this pull request May 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants