| id | DEV-220 |
|---|---|
| title | Reference Issues and PRs as List Items |
| status | active |
| enforcement | manual |
| severity | warning |
An issue or PR URL pasted inline in a sentence does not expand to its title and is easily lost in prose. Readers cannot see at a glance what is referenced.
Reference issues and pull requests as list items, so GitHub expands each to show its title.
See these related items:
- <issue_or_pr_url>
- #4
- #12Do not paste references inline in a sentence.
- Issue and PR references are list items, not inline in prose
- Each reference sits on its own line