[docs]: Use consistent vocabulary and enforce it - #151
Open
pseudomuto wants to merge 1 commit into
Open
Conversation
The README terms table has named this project's vocabulary for a while, but nothing ensured those terms were used. Upstream config and the proxy package still called a Temporal Service a cluster or a frontend, the goreleaser blurb shipped the wrong word in every release note, etc. Settle all of it on the canonical terms, then add a checker so it stays settled. `mise run lint:terms` (runs in CI) flags rejected phrases in Go, markdown and YAML, and enforces the core nouns as proper nouns in markdown prose only. Scope comes from `git ls-files`, so .gitignore and .git/info/exclude already decide what is in play and terms.yaml defines any ignores git cannot infer. Every exception records why it is there. The checker is its own Go module, so the root go.mod gains no dependency, and SKILL.md doubles as the reference a reviewer reads. The Copilot review instructions point at it instead of restating the term list, so the two cannot drift, and the review skill inherits that through its existing include.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! 🚀 New features to boost your workflow:
|
Vaughan-Temporal
approved these changes
Sep 4, 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
3 participants
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.
The README terms table has named this project's vocabulary for a while, but nothing has ensured those terms are used. Upstream config and the proxy package still refer to a Temporal Service as a cluster or a frontend. The goreleaser blurb shipped the wrong word in every release note, etc.
Settle all of it on the canonical terms, then add a checker so it stays settled.
mise run lint:terms(runs in CI) flags rejected phrases in Go, Markdown and YAML, and enforces the core nouns as proper nouns in Markdown prose only. Scope comes fromgit ls-files, so .gitignore and .git/info/exclude already decide what is in play and terms.yaml defines any ignores git cannot infer. Every exception records why it is there.The checker is its own Go module, so the root go.mod gains no dependency, and SKILL.md doubles as the reference a reviewer reads. The Copilot review instructions point at it instead of restating the term list, so the two cannot drift, and the review skill inherits that through its existing include.