Skip to content

Commit a5d0b1b

Browse files
committed
Add issue and pr convention to AGENTS.md
1 parent bd60323 commit a5d0b1b

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

AGENTS.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -347,3 +347,15 @@ Most formatting is automated by [Hongdown]. Key conventions to follow:
347347
See *CONTRIBUTING.md* for complete Markdown conventions.
348348

349349
[Hongdown]: https://github.com/dahlia/hongdown
350+
351+
352+
Issues and PR descriptions
353+
--------------------
354+
355+
- Unlike other Markdown files in this repository, do not wrap lines at
356+
80 columns
357+
- Follow the documentation standards and Markdown conventions sections above
358+
for all other formatting
359+
- Use `#123` shorthand for issue and PR references instead of permalink URLs
360+
- Include rationales in descriptions: explain the background and motivation
361+
behind the change, not just what was changed

0 commit comments

Comments
 (0)