Doc: add guidance on taking over a stale pull request#13877
Conversation
|
I think we don't need changelog entry for this, please let me know if this needs further improvements. (i'll fix these ci failures) |
| git checkout -b takeover-XXXXX original-author/<their-branch-name> | ||
|
|
||
| Then push to your fork and open a new PR referencing the original | ||
| (e.g., "Takes over :gh:`XXXXX`"). Make sure their name is in |
There was a problem hiding this comment.
I suggest specifying that "Takes over..." can be in the PR description rather than the title (like how referencing issues is handled).
Maybe also worth mentioning to still include a "Fixes #XYZ" for the original issue.
| If a pull request has been abandoned, you can take it over. Always credit | ||
| the original author by adding a ``Co-authored-by`` trailer to your commit | ||
| message:: | ||
|
|
||
| Co-authored-by: Original Author Name <their-email@example.com> |
There was a problem hiding this comment.
- Worth specifying that only one commit needs to include the original author as a co-author, e.g., a commit that adds or edits a changelog entry.
- I think this crediting info should come at the end, alongside the instructions about adding them to
names.incand including them in the changelog entry.
| Taking over a stale pull request | ||
| --------------------------------- | ||
|
|
||
| If a pull request has been abandoned, you can take it over. Always credit |
There was a problem hiding this comment.
We should also specify a bit more about establishing whether a PR is abandoned. E.g.:
- the PR hasn't seen a commit in several weeks, and the author hasn't already stated that they will continue working on the PR after a certain period of time
- the author of the original PR is pinged with a question about whether they intend to contribute further to the PR, and they confirm they will not contribute further or they don't respond after 1 week
WDYT @drammock?
There was a problem hiding this comment.
2 weeks, to allow for holidays etc
Co-authored-by: Thomas S. Binns <t.s.binns@outlook.com>
Co-authored-by: Thomas S. Binns <t.s.binns@outlook.com>
|
@tsbinns thanks ❤️ for the review and the pointer, it make sense, to add some more details, i'll address these review points tomorrow, as its here approx 1 am ... |
3 participants
Fixes #13860
What does this implement/fix?
Additional information