Skip to content

chore: doc writing rules for the agents - #4289

Open
albinsuresh wants to merge 2 commits into
thin-edge:mainfrom
albinsuresh:openspec-workflow-update
Open

chore: doc writing rules for the agents#4289
albinsuresh wants to merge 2 commits into
thin-edge:mainfrom
albinsuresh:openspec-workflow-update

Conversation

@albinsuresh

@albinsuresh albinsuresh commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Proposed changes

Only the last commit is worth reviewing. The one before contains just updated the openspec commands and workflows done automatically by openspec update command.

  • chore: doc writing rules for the agents
  • enable update workflow of openspec
  • update the existing workflows to latest definitions (done automatically on openspec update)

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue


Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s. You can activate automatic signing by running just prepare-dev once)
  • I ran just format as mentioned in CODING_GUIDELINES
  • I used just check as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

@albinsuresh
albinsuresh requested review from jarhodes314 and rina23q and removed request for didier-wenzek and reubenmiller July 30, 2026 04:59
@codecov

codecov Bot commented Jul 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@rina23q rina23q left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I checked only two files: config.yaml and AGENTS.md, because others are auto-generated files.

Comment thread AGENTS.md
Comment on lines +293 to +295
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).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Suggested change
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.

@albinsuresh albinsuresh Jul 31, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread openspec/config.yaml
# - Break tasks into chunks of max 2 hours
rules:
proposal:
- After "Why", add a "Proposed solution" section that introduces the feature from the

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the difference between "Proposed solution" and "What Changes"?

@albinsuresh albinsuresh Jul 31, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread openspec/config.yaml Outdated
# Domain: e-commerce platform
context: |
Writing style (all artifacts): plain, direct English.
Use semantic line breaks.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed in 3068db7

@albinsuresh
albinsuresh force-pushed the openspec-workflow-update branch from 23ef1cb to 3068db7 Compare July 31, 2026 07:45
@reubenmiller reubenmiller added the skip-release-notes Don't include the ticket in the auto generated release notes label Jul 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip-release-notes Don't include the ticket in the auto generated release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants