Skip to content
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.

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

PEP 770: Improving measurability of Python packages with Software Bill-of-Materials #4187

Merged
merged 9 commits into from
Jan 6, 2025

Conversation

sethmlarson
Copy link
Contributor

@sethmlarson sethmlarson commented Jan 2, 2025

Basic requirements (all PEP Types)

  • Read and followed PEP 1 & PEP 12
  • File created from the latest PEP template
  • PEP has next available number, & set in filename (pep-NNNN.rst), PR title (PEP 123: <Title of PEP>) and PEP header
  • Title clearly, accurately and concisely describes the content in 79 characters or less
  • Core dev/PEP editor listed as Author or Sponsor, and formally confirmed their approval
  • Author, Status (Draft), Type and Created headers filled out correctly
  • PEP-Delegate, Topic, Requires and Replaces headers completed if appropriate
  • Required sections included
    • Abstract (first section)
    • Copyright (last section; exact wording from template required)
  • Code is well-formatted (PEP 7/PEP 8) and is in code blocks, with the right lexer names if non-Python
  • PEP builds with no warnings, pre-commit checks pass and content displays as intended in the rendered HTML
  • Authors/sponsor added to .github/CODEOWNERS for the PEP

Standards Track requirements

  • PEP topic discussed in a suitable venue with general agreement that a PEP is appropriate
  • Suggested sections included (unless not applicable)
    • Motivation
    • Rationale
    • Specification
    • Backwards Compatibility
    • Security Implications
    • How to Teach This
    • Reference Implementation
    • Rejected Ideas
    • Open Issues
  • Python-Version set to valid (pre-beta) future Python version, if relevant
  • Any project stated in the PEP as supporting/endorsing/benefiting from the PEP formally confirmed such
  • Right before or after initial merging, PEP discussion thread created and linked to in Discussions-To and Post-History

cc @brettcannon


📚 Documentation preview 📚: https://pep-previews--4187.org.readthedocs.build/

@sethmlarson sethmlarson requested a review from a team as a code owner January 2, 2025 21:43
@hugovk
Copy link
Member

hugovk commented Jan 3, 2025

(Resolved conflict to kick off the CI.)

@hugovk hugovk added the new-pep A new draft PEP submitted for initial review label Jan 3, 2025
@sethmlarson sethmlarson requested a review from hugovk January 3, 2025 16:49
@sethmlarson
Copy link
Contributor Author

Thanks for the review Hugo! 💜

Co-authored-by: Hugo van Kemenade <[email protected]>
@sethmlarson sethmlarson requested a review from hugovk January 3, 2025 18:59
Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good from an editorial perspective, cc @brettcannon for content.

@brettcannon brettcannon merged commit a57a485 into python:main Jan 6, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new-pep A new draft PEP submitted for initial review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants