[RFC] Simplify release note creation
Open
Nobody has claimed this yet.
needs discussion
- Dominant language
- Python
- Stars
- 17.9k
- Forks
- 7.3k
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 13
Description
Few ideas on how to simplify the release note creation by structuring PRs.
For example, those projects are using tools to automate some part of the process:
- spyder ide, https://github.com/spyder-ide/loghub/
- sympy, https://github.com/sympy/sympy/pull/19640#issuecomment-649379944
- https://pypi.org/project/towncrier/
There are pros/cons for automation approaches:
- automation
- should explain how to use the bots for the PR note writing
cc @datumbox
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 by reviewing the linked Loghub project, SymPy bot and release-note guidance, and towncrier to compare the proposed approaches. Done would require a decided release-note workflow plus clear documentation for how PR authors use it and the trade-offs of automation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, python
- Domain
- documentation, release, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100