mirror of
https://github.com/penpot/penpot.git
synced 2026-11-06 01:50:39 +00:00
📚 Make the no-wrap rule cover comments and review replies
The writing principles of the PR memory carried the no-wrap rule inside the PR description section, so it read as description-only and comments kept getting hard-wrapped. Say that it applies to PR and issue comments and to review replies too. AI-assisted-by: deepseek-v4.1-flash
This commit is contained in:
parent
d5e7fe59c9
commit
d0a4ffc2c0
@ -66,7 +66,7 @@ The "Note:" line is required at the top. Adjust if this is a manual (non-AI) PR.
|
||||
- **Write for humans.** The diff shows what changed. The description explains why.
|
||||
- **Be concise.** Focus on reasoning: What was the problem? Why did it happen? How did you solve it?
|
||||
- **Prefer bullets over paragraphs.** Short bullet items, grouped by area with bold lead-ins where helpful, are far easier to digest than prose; keep any remaining paragraph to a few sentences.
|
||||
- **No manual line wraps.** Markdown renders adapting to the viewport; hard-wrapped lines degrade rendering. One line per paragraph or bullet, however long.
|
||||
- **No manual line wraps.** Markdown renders adapting to the viewport; hard-wrapped lines degrade rendering. One line per paragraph or bullet, however long. This applies to PR descriptions and to PR/issue comments and review replies alike.
|
||||
- **Skip the obvious.** Don't explain what `git diff` already shows.
|
||||
|
||||
### What NOT to Include
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user