gsadmin/rustfs
1
0
Fork 0
mirror of https://github.com/rustfs/rustfs.git synced 2026-08-20 03:22:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(agents): forbid hard-wrapping prose in PR/issue bodies (#4374)

Browse Source 
GitHub renders single newlines inside a paragraph as line breaks, so hard-wrapped PR/issue/discussion prose shows up with ugly mid-sentence breaks. Add a rule under Git and PR Baseline to keep each paragraph on one line.
This commit is contained in:
Zhengchao An
2026-07-07 22:16:07 +08:00
committed by GitHub
parent 2dfa3d3c36
commit 9e6d7de0fa
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+4
View File
@@ -108,6 +108,10 @@ Do not open a PR with code changes when the required checks fail.
- Include verification commands in the PR description. - Include verification commands in the PR description.
- When using `gh pr create`/`gh pr edit`, use `--body-file` instead of inline `--body` for multiline markdown. - When using `gh pr create`/`gh pr edit`, use `--body-file` instead of inline `--body` for multiline markdown.
- Do not include the literal sequence `\n` in any GitHub issue, pull request, or discussion comment. - Do not include the literal sequence `\n` in any GitHub issue, pull request, or discussion comment.
- Do not hard-wrap prose in PR/issue/discussion bodies; write each paragraph as a
single line and let it reflow. GitHub renders single newlines inside a paragraph
as line breaks, so mid-sentence wrapping shows up as ugly breaks. Only break lines
for list items, code blocks, and deliberate separators.
- After fixing code review comments or CI findings, always mark corresponding review - After fixing code review comments or CI findings, always mark corresponding review
comments/threads as resolved before returning to the user. comments/threads as resolved before returning to the user.
- In handling review comments, confirm the underlying issue before changing code. - In handling review comments, confirm the underlying issue before changing code.