pypa / pypa/packaging.python.org

Process of proposing (new) specifications may not sufficiently clearly explained

Open
#764 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.7k
Forks
1.7k
Avg merge
3d 12h
Merged PRs (30d)
4

Description

From https://discuss.python.org/t/adding-a-default-extra-require-environment/4898/48?u=pradyunsg

I found this: https://www.pypa.io/en/latest/specifications/#proposing-new-specifications but honestly it’s quite confusing and not really helpful.

I try to understand:

  • How to obtain a PEP number ?
  • Where should I go to open the PEP ?
  • Is the PR to " Python Packaging User Guide repository" the PEP itself ? Or it’s a completely different process and shall be done once we have reached consensus in the PEP ?
  • Is there a template I can follow ?

I feel that these are all legitimate questions about the process that we don't clarify well enough, and we should possibly clarify each of these points in/near the "Proposing new specifications" section.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the "Proposing new specifications" section linked in the issue and compare it with the four questions raised. Update the guidance so it explains how to obtain a PEP number, where to open a PEP, how the packaging.python.org PR relates to the PEP process, and whether a template exists. Done means a newcomer can follow the process without the cited confusion.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.