Skip to content

docs: add contributor style guide (#116) - #243

Open
SilanHe wants to merge 3 commits into
mainfrom
docs/issue-116-style-guide
Open

docs: add contributor style guide (#116)#243
SilanHe wants to merge 3 commits into
mainfrom
docs/issue-116-style-guide

Conversation

@SilanHe

@SilanHe SilanHe commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Adds STYLE_GUIDE.md for contributors, covering writing and grammar (distinct from the technical authoring syntax): active voice, no em-dash, prose over listicles, terminology, and no marketing language.

Extracts the overlapping writing-style prose out of authoring-guide.md into the new guide and points to it, keeping one canonical source.

Closes #116

hsilan added 2 commits August 6, 2026 22:12
Add STYLE_GUIDE.md covering writing and grammar: active voice, no
em-dash, prose over listicles, terminology, and no marketing language.
Extract the overlapping writing-style prose out of authoring-guide.md
and point it at the new guide, keeping one canonical source.

Closes #116
Copy the writing-style prose from authoring-guide verbatim instead of
expanding it, and add a Naming section for the product names (AWS Lambda
durable functions, durable functions, Durable Execution SDK, durable
execution).
Comment thread style-guide.md
@yaythomas

Copy link
Copy Markdown
Contributor

❤️ this, ty!

Match the lowercase-hyphenated case of authoring-guide.md and update
the links to it.
@SilanHe
SilanHe deployed to ai-pr-review August 7, 2026 21:21 — with GitHub Actions Active
@SilanHe
SilanHe had a problem deploying to ai-pr-review-runtime August 7, 2026 21:21 — with GitHub Actions Failure
@SilanHe
SilanHe had a problem deploying to ai-pr-review-runtime August 7, 2026 21:21 — with GitHub Actions Failure
@SilanHe
SilanHe marked this pull request as ready for review August 7, 2026 21:27
@SilanHe
SilanHe had a problem deploying to ai-pr-review-runtime August 7, 2026 21:27 — with GitHub Actions Failure
@SilanHe
SilanHe had a problem deploying to ai-pr-review-runtime August 7, 2026 21:27 — with GitHub Actions Failure
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.

style guide

3 participants