docs: add contributor style guide (#116) - #243
Open
SilanHe wants to merge 3 commits into
Open
Conversation
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).
yaythomas
reviewed
Aug 7, 2026
Contributor
|
❤️ this, ty! |
Match the lowercase-hyphenated case of authoring-guide.md and update the links to it.
SilanHe
had a problem deploying
to
ai-pr-review-runtime
August 7, 2026 21:21 — with
GitHub Actions
Failure
SilanHe
had a problem deploying
to
ai-pr-review-runtime
August 7, 2026 21:21 — with
GitHub Actions
Failure
SilanHe
marked this pull request as ready for review
August 7, 2026 21:27
SilanHe
had a problem deploying
to
ai-pr-review-runtime
August 7, 2026 21:27 — with
GitHub Actions
Failure
SilanHe
had a problem deploying
to
ai-pr-review-runtime
August 7, 2026 21:27 — with
GitHub Actions
Failure
yaythomas
approved these changes
Aug 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
STYLE_GUIDE.mdfor 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.mdinto the new guide and points to it, keeping one canonical source.Closes #116