Improvements to Lifecycle of a pull request
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.1k
- Forks
- 1k
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 12
Description
I write this issue as a feedback from Euro Python 2024 sprint to denote troubles I encountered as I contributed to cpython.
Describe the enhancement or feature you'd like
Missing content in "Lifecycle of a pull request" https://devguide.python.org/getting-started/pull-request-lifecycle/
- "Quick guide" is missing a step to create
NEWS.drecord. It's just very briefly mentioned inpatchcheck. - "Step-by-step guide" doesn't denote a branch naming convention. I was told to use
gh-<number>-<name>. - "Making good commits" doesn't mention
gh-<number>should be included in the commit message. - "Step-by-step guide" doesn't mention
gh-<number>should be included in the PR title.
Describe alternatives you've considered
None.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked “Lifecycle of a pull request” page in the Python developer’s guide and review its Quick guide, Step-by-step guide, and Making good commits sections. Update the documentation to cover the NEWS.d record and the gh- naming and message conventions; done means all four requested workflow details are clearly stated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100