Skip to content

docs: add guidance for coordinating issue contributions - #1980

Open
iamnicocr wants to merge 1 commit into
python:mainfrom
iamnicocr:docs-1389-contributor-etiquette
Open

iamnicocr wants to merge 1 commit into
python:mainfrom
iamnicocr:docs-1389-contributor-etiquette

Conversation

@iamnicocr

Copy link
Copy Markdown

Summary

  • Added a new section, "Coordinating work on an issue", to the pull request lifecycle documentation.
  • Provided six guidelines covering:
    • Checking for existing contributions before starting work.
    • Communicating intentions and approximate timelines.
    • Sharing progress and requesting assistance when blocked.
    • Respecting contributors who are already working on an issue.
    • Allowing others to continue unfinished contributions.
    • Coordinating before taking over inactive issues.
  • Clarified that estimated timelines are not strict deadlines and that contributors should discuss the status of inactive work before proceeding.

Motivation

This change aims to reduce duplicated work and improve coordination among contributors interested in resolving the same issue.

The guidelines are presented as recommendations rather than mandatory policies, leaving room for maintainers to review and refine the proposed approach.

Testing

  • HTML documentation build (.\make.bat html) — Passed.
  • Documentation lint (sphinxlint) — Passed.
  • Whitespace verification (git diff --check) — Passed.
  • External link check — Not rerun because of the previously encountered Internet Archive rate limiting.

Related issue

Refs #1389

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 CPython devguide | 🛠️ Build #35898056 | 📁 Comparing 1e56e02 against latest (8c852bd)

  🔍 Preview build  

1 file changed
± getting-started/pull-request-lifecycle/index.html

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.

1 participant