chore: doc writing rules for the agents - #4289
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! 🚀 New features to boost your workflow:
|
rina23q
left a comment
There was a problem hiding this comment.
I checked only two files: config.yaml and AGENTS.md, because others are auto-generated files.
| When writing or editing Markdown documents, use [semantic line breaks](https://sembr.org/): | ||
| start a new line after each sentence, and optionally break long sentences | ||
| at clause boundaries (after commas, semicolons, colons, or dashes). |
There was a problem hiding this comment.
The rule has no scope limit, so it applies to every Markdown file in the repo. Most of the existing Markdown doesn't follow semantic line breaks.
So an agent that fixes one sentence in a docs/ page is told to reflow the whole file, and every change carries a large format-only diff. Can we scope the rule to the files where we want this style, and say explicitly not to reflow the rest?
| When writing or editing Markdown documents, use [semantic line breaks](https://sembr.org/): | |
| start a new line after each sentence, and optionally break long sentences | |
| at clause boundaries (after commas, semicolons, colons, or dashes). | |
| When writing or editing Markdown under `openspec/`, `design/`, `AGENTS.md`, or PR | |
| and commit descriptions, use [semantic line breaks](https://sembr.org/): | |
| start a new line after each sentence, and optionally break long sentences | |
| at clause boundaries (after commas, semicolons, colons, or dashes). | |
| Do not reflow existing files that don't follow this style — `docs/` and | |
| `CONTRIBUTING.md` use their own line-wrapping conventions. If a reflow is | |
| genuinely needed, put it in its own commit, separate from content changes. |
There was a problem hiding this comment.
I wouldn't exclude the docs directory, but I'll add that hint not to update the entire doc while updating an existing doc that doesn't follow the same convention. Updated in 3068db7.
| # - Break tasks into chunks of max 2 hours | ||
| rules: | ||
| proposal: | ||
| - After "Why", add a "Proposed solution" section that introduces the feature from the |
There was a problem hiding this comment.
What is the difference between "Proposed solution" and "What Changes"?
There was a problem hiding this comment.
Proposed Solution focusses on the direct user-impact of the feature, where as What Changes contains the details of how various components in the system need to be changed to provide that feature (the highlevel overview). The design.md is a detailed expansion of this What Changes section.
| # Domain: e-commerce platform | ||
| context: | | ||
| Writing style (all artifacts): plain, direct English. | ||
| Use semantic line breaks. |
There was a problem hiding this comment.
This is a duplicate of the rule in AGENTS.md. If the AGENTS.md rule covers openspec/, we can drop this line and keep one source.
23ef1cb to
3068db7
Compare
Proposed changes
Only the last commit is worth reviewing. The one before contains just updated the openspec commands and workflows done automatically by
openspec updatecommand.updateworkflow of openspecopenspec update)Types of changes
Paste Link to the issue
Checklist
just prepare-devonce)just formatas mentioned in CODING_GUIDELINESjust checkas mentioned in CODING_GUIDELINESFurther comments