Release note ticket numbers should be links
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6k
- Forks
- 1.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 10
Description
The release notes contain #1234 style references to tickets, and this note at the top:
Ticket numbers in this file can be looked up by visiting https://twisted.org/trac/ticket/<number>
This is awkward. As the release notes are no longer plain text they can be real links, like treq does:
https://github.com/twisted/treq/blob/0cf19207f46fb30fa18bc4e3505099743773e5a7/pyproject.toml#L15
We can migrate the old references too.
Complication: some tickets were migrated from Trac. Some were not.
This file lists the migrated tickets. Any ticket number greater than #11560 can be assumed to only exist in GitHub.
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 NEWS.rst and review the ticket-link style shown in treq's pyproject.toml. Use redirect_trac_tickets.js to distinguish migrated tickets from tickets above #11560, then update the old references and the lookup note in NEWS.rst. Done means the release-note ticket numbers are links to the correct destination.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100