Skip to content

docs(guidelines): adopt semantic line breaks (SemBr) across repository - #1108

Open
onlyarnav wants to merge 2 commits into
apache:mainfrom
onlyarnav:docs/adopt-sembr
Open

docs(guidelines): adopt semantic line breaks (SemBr) across repository#1108
onlyarnav wants to merge 2 commits into
apache:mainfrom
onlyarnav:docs/adopt-sembr

Conversation

@onlyarnav

Copy link
Copy Markdown
Member

Summary

  • Adopts the Semantic Line Breaks (SemBr) standard across the repository's guidelines and templates.
  • Adds rules and rationale in AGENTS.md and docs/editorial-guidelines.md requiring one-sentence-per-line formatting for clear, minimal git diffs.
  • Links this one-statement-per-line philosophy in CONTRIBUTING.md (English as code) and skills/write-skill/SKILL.md (skill authoring guidelines).

Type of change

  • Cross-cutting (RFC, AGENTS.md, sandbox, privacy-LLM)
  • Documentation (docs/, README.md, CONTRIBUTING.md)

RFC-AI-0004 compliance

  • Vendor neutrality — placeholders (<PROJECT>, <tracker>, <upstream>, <security-list>) used in all skill / tool prose.

Linked issues

Closes #1094


Generated-by: Claude Code (Opus 5)

Comment thread docs/editorial-guidelines.md Outdated
@onlyarnav
onlyarnav force-pushed the docs/adopt-sembr branch 2 times, most recently from 694fd8d to a08663a Compare August 21, 2026 18:15
ppkarwasz
ppkarwasz previously approved these changes Aug 21, 2026

@ppkarwasz ppkarwasz 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.

LGTM!

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adopts Semantic Line Breaks (SemBr) as repository-wide prose guidance, addressing #1094.

Changes:

  • Documents sentence- and clause-boundary formatting.
  • Adds SemBr guidance to contributor and skill-authoring workflows.
  • Updates the editorial guidelines TOC.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
AGENTS.md Adds repository-wide SemBr instructions.
CONTRIBUTING.md Adds SemBr as an English-code convention.
docs/editorial-guidelines.md Defines SemBr rules and rationale.
skills/write-skill/SKILL.md Requires SemBr when authoring skills.
Suppressed comments (1)

AGENTS.md:868

  • This modified sentence still has arbitrary hard wraps, including splitting the quoted phrase after the and separating lives in from its link. Reflow the full sentence at semantic boundaries; since it has no useful clause split beyond list commas, a single source line follows the new rule most clearly.
semantic line breaks, and the CVE / tracker-issue / PR link formats — lives in

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread skills/write-skill/SKILL.md
Comment thread AGENTS.md Outdated
ppkarwasz
ppkarwasz previously approved these changes Aug 22, 2026
@onlyarnav
onlyarnav force-pushed the docs/adopt-sembr branch 2 times, most recently from 9205e39 to ca4c023 Compare August 22, 2026 12:13
Adopt the SemBr (Semantic Line Breaks) standard for formatting prose
across skills, documentation, and canned responses. This ensures that
single-sentence modifications result in clean, minimal diffs without
reflow issues.

Generated-by: Antigravity
@onlyarnav

Copy link
Copy Markdown
Member Author

Re-requesting an approval, earlier versions were causing prek to fail due to check-family-plugins pre-commit hook fails whenever any skill file was being edited because the report-framework-issue skill was missing its corresponding marketplace plugin symlink plugins/magpie-utilities/skills/report-framework-issue.

I have merged a PR fixing that issue, and now everything is clear

@onlyarnav
onlyarnav requested a review from ppkarwasz August 22, 2026 12:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Use semantic line breaks in skills

3 participants