Skip to content

docs: add guidance for coordinating issue contributions #1980

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.

Sign up for GitHub

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

Open
iamnicocr wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add guidance for coordinating issue contributions #1980

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions getting-started/pull-request-lifecycle.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,45 @@ should do to help ensure that your pull request is accepted.

#. Proper :ref:`documentation <documenting>` additions/changes should be included.

Coordinating work on an issue
-----------------------------

Before starting work on an issue, contributors should coordinate with
others to avoid duplicating efforts and to make collaboration easier.

#. **Check for existing contributions.** Before working on an issue,
review its discussion and any linked pull requests. If another
contributor is already working on a solution, consider offering
assistance or discussing possible collaboration instead of
submitting a competing pull request.

#. **Communicate your intentions.** Contributors are encouraged to
express their interest in an issue and describe their planned
approach. Providing an approximate timeframe can help others
understand when to expect progress, although these estimates
should not be treated as strict deadlines.

#. **Share progress and ask for help.** If difficulties arise or
progress is delayed, contributors should communicate any blockers
and seek assistance when appropriate. Opening a draft pull
request can help others review work in progress and provide
early feedback.

#. **Respect ongoing work.** Contributors should avoid taking over
an issue while someone else is actively working on it. If progress
has stopped, discuss the situation with the original contributor
and maintainers before proceeding.

#. **Allow others to continue unfinished work.** Contributors who
are unable to complete their work are encouraged to communicate
this in the issue. This gives other interested contributors an
opportunity to continue the effort.

#. **Coordinate before taking over inactive issues.** If an issue
has remained inactive beyond an estimated timeframe, contributors
should discuss its status before starting a new solution. An
expired estimate does not automatically transfer responsibility.

.. _news-entry:
.. _what-s-new-and-news-entries:

Expand Down