Skip to content

Commit 741dafa

Browse files
Aniketsytsbinnsdrammock
authored
Doc: add guidance on taking over a stale pull request (#13877)
Co-authored-by: Thomas S. Binns <t.s.binns@outlook.com> Co-authored-by: Daniel McCloy <dan@mccloy.info>
1 parent e2ee35e commit 741dafa

1 file changed

Lines changed: 46 additions & 0 deletions

File tree

doc/development/contributing.rst

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -663,6 +663,52 @@ change, and append additional PR numbers in parentheticals with the ``:gh:`` rol
663663
664664
Short description of the changes, by `Firstname Lastname`_. (:gh:`12346`)
665665
666+
667+
.. _taking-over-a-stale-pr:
668+
669+
Taking over a stale pull request
670+
--------------------------------
671+
672+
If a pull request has been abandoned, someone else can take it over. A PR is generally
673+
considered abandoned when there have been no commits for several weeks, and the original
674+
author has not already indicated that they plan to continue at a later time. In this
675+
case, first ping the author in a comment on the PR, asking if they intend to continue
676+
working on it. If the original author replies that they do not intend to continue the
677+
work, or there is no reply after at least 2 weeks, you can take over the PR.
678+
679+
To build on top of the original author's existing work, you can add a copy of the branch
680+
they were working on to your fork:
681+
682+
.. code-block:: bash
683+
684+
git remote add original-author https://github.com/original-author/mne-python.git
685+
git fetch original-author
686+
git checkout -b some-new-feature original-author/some-new-feature
687+
688+
You can then push any further commits to, and open a PR from, this new branch on your
689+
fork.
690+
691+
Reference the original PR number in the description of the new PR (e.g., "Closes
692+
#12345 (supersedes)"), and keep any links to the corresponding issue (e.g., "Fixes #12340").
693+
694+
Before the PR is merged, make sure the original author is credited for their existing
695+
work. To credit them in the documentation, add their name to ``doc/changes/names.inc``,
696+
if not already included, and add them as an author in the changelog entry, e.g.:
697+
698+
.. code-block:: rst
699+
700+
Short description of the changes, by `Your Name`_ and `Original Author Name`_.
701+
702+
To credit the original author in the code, add their name and email as a co-author to
703+
the end of at least one commit message (e.g., the commit that adds the changelog
704+
entry):
705+
706+
.. code-block:: rst
707+
708+
Your commit message
709+
710+
Co-authored-by: Original Author Name <original-author-email@example.com>
711+
666712
Continuous integration (CI) and local testing before opening a PR
667713
-----------------------------------------------------------------
668714

0 commit comments

Comments
 (0)