diff --git a/pep-0001.txt b/pep-0001.txt index ffdda84092f..92b4694356b 100644 --- a/pep-0001.txt +++ b/pep-0001.txt @@ -188,7 +188,7 @@ The standard PEP workflow is: "Informational", or "Process" as appropriate, and for the "Status:" field enter "Draft". For full details, see `PEP Header Preamble`_. -* Update `.github/CODEOWNERS` [3]_ such that any co-author(s) or sponsors +* Update `.github/CODEOWNERS`_ such that any co-author(s) or sponsors with write access to the `PEP repository`_ are listed for your new file. This ensures any future pull requests changing the file will be assigned to them. @@ -530,7 +530,9 @@ PEP Header Preamble Each PEP must begin with an :rfc:`2822` style header preamble. The headers must appear in the following order. Headers marked with "*" are -optional and are described below. All other headers are required. :: +optional and are described below. All other headers are required. + +.. code-block:: text PEP: Title: @@ -708,7 +710,7 @@ For each new PEP that comes in an editor does the following: * The file name extension is correct (i.e. ``.rst``). * Ensure that everyone listed as a sponsor or co-author of the PEP who has write - access to the `PEP repository`_ is added to `.github/CODEOWNERS` [3]_. + access to the `PEP repository`_ is added to `.github/CODEOWNERS`_. * Skim the PEP for obvious defects in language (spelling, grammar, sentence structure, etc.), and code style (examples should conform to @@ -737,12 +739,8 @@ Once the PEP is ready for the repository, a PEP editor will: ("Standards Track", "Informational", or "Process"), and marked its status as "Draft". -* Add the PEP to a local fork of the PEP repository. For workflow - instructions, follow `The Python Developers Guide `_ - - The git repo for the peps is:: - - https://github.com/python/peps +* Add the PEP to a local fork of the `PEP repository`_. For workflow + instructions, follow `The Python Developers Guide `_ * Run ``./genpepindex.py`` and ``./pep2html.py `` to ensure they are generated without errors. If either triggers errors, then the web site @@ -770,15 +768,12 @@ administrative & editorial part (which is generally a low volume task). Resources: -* `Index of Python Enhancement Proposals `_ +* `Index of Python Enhancement Proposals `_ * `Following Python's Development - `_ - -* `Python Developer's Guide `_ + `_ -* `Frequently Asked Questions for Developers - `_ +* `Python Developer's Guide `_ References and Footnotes @@ -792,17 +787,17 @@ References and Footnotes in the PEPs repo README at https://github.com/python/peps/blob/main/README.rst -.. [3] `CODEOWNERS` documentation - (https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners) +.. _.github/CODEOWNERS: + https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners .. _issue tracker: - http://bugs.python.org/ + https://bugs.python.org/ .. _CC0-1.0-Universal: https://choosealicense.com/licenses/cc0-1.0/ -.. _reStructuredText: http://docutils.sourceforge.net/rst.html +.. _reStructuredText: https://docutils.sourceforge.io/rst.html -.. _Docutils: http://docutils.sourceforge.net/ +.. _Docutils: https://docutils.sourceforge.io/ .. _PEP repository: https://github.com/python/peps