Skip to content

docs: writing style, sentence structure, punctuation#396

Merged
KSXGitHub merged 9 commits intomasterfrom
claude/improve-docs-style-ocvBZ
Apr 25, 2026
Merged

docs: writing style, sentence structure, punctuation#396
KSXGitHub merged 9 commits intomasterfrom
claude/improve-docs-style-ocvBZ

Conversation

@KSXGitHub
Copy link
Copy Markdown
Owner

No description provided.

claude added 2 commits April 25, 2026 10:23
Add a writing style guideline in CONTRIBUTING.md and the AI instruction
templates that prefers complete sentences and discourages mid-sentence
breaks introduced by em dashes or long parenthetical clauses. Apply the
same style throughout the existing prose so the guidance and the docs
agree.
Comment thread CONTRIBUTING.md
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 25, 2026

Performance Regression Reports

commit: c23992c

There are no regressions.

Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md Outdated
@KSXGitHub KSXGitHub marked this pull request as ready for review April 25, 2026 12:29
Copy link
Copy Markdown
Owner Author

@KSXGitHub KSXGitHub left a comment

Choose a reason for hiding this comment

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

Independent review by a second-pass review agent. Each finding is annotated inline above. I will follow up with a recommendation (accept / reject / optional) as a reply on each thread so you can decide.


Generated by Claude Code

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md Outdated
Comment thread template/ai-instructions/shared.md
Comment thread template/ai-instructions/shared.md Outdated
@KSXGitHub KSXGitHub merged commit 697ad36 into master Apr 25, 2026
13 checks passed
@KSXGitHub KSXGitHub deleted the claude/improve-docs-style-ocvBZ branch April 25, 2026 13:02
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.

2 participants