pypa / pypa/packaging.python.org

Replace News document with an automated monthly changelog

Open
#1,384 6 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Help give maintainers and readers information on what has been changed/added/removed in the Packaging Guide by creating a monthly sectioned changelog. This would be similar to the existing News Page. Ideally, we would automate this.

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 reviewing the existing News Page and how changes to the Packaging Guide are currently presented. Define the monthly sections and the automation approach with maintainers; done means a documented, repeatable changelog process that reports what was changed, added, and removed.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, release
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.