Skip to content

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

Open
onlyarnav wants to merge 1 commit into
apache:mainfrom
onlyarnav:docs/adopt-sembr
Open

docs(guidelines): adopt semantic line breaks (SemBr) across repository#1108
onlyarnav wants to merge 1 commit 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
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

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

[`tools/dev/check-placeholders.sh`](../../tools/dev/check-placeholders.sh)
prek hook catches the obvious cases but it is a backstop, not a
substitute for getting the placeholder right at write time.
- **Semantic line breaks ([SemBr](https://sembr.org)).**
Comment thread AGENTS.md
Comment on lines +858 to +859
Format prose across the repository (skills, docs, canned responses) using
**semantic line breaks** ([SemBr](https://sembr.org)).
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