new (style): Updated contributing docs and Vale for style guide assistance#16267
new (style): Updated contributing docs and Vale for style guide assistance#16267
Conversation
… IDE prose linting tool
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.
| - Use "use" not "utilize" | ||
| - Verb forms: "set up" (verb) vs "setup" (noun), "log in" vs "login" | ||
|
|
||
| For the complete style guide, see: https://docs.sentry.io/contributing/approach/style-guide/ |
There was a problem hiding this comment.
Duplicated style guide content between AGENTS.md and SKILL.md
Medium Severity
The new "Documentation Writing Style" section substantially duplicates content from .claude/skills/docs-review/SKILL.md. Both files contain nearly identical guidelines for Tone & Voice (Supportive Peer, Direct & Honest, Inclusive), Stylistic Rules (American English, Scannability, Active Voice, Headings), and Formatting (Code First, Bold for Emphasis). Consider having AGENTS.md reference the skill file or style-guide.mdx instead of duplicating the content.
|
|
||
| ### Word Choice | ||
| - Use "blocklist/allowlist" not "blacklist/whitelist" | ||
| - Use "primary/replica" not "master/slave" |
There was a problem hiding this comment.
Agree on the concept but primary/replica isn't developer parlance.
2 participants
DESCRIBE YOUR PR
Main preview: https://sentry-docs-git-style-guide-and-vale-linter.sentry.dev/contributing/approach/style-guide/
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
- Checked Vercel preview for correctness, including links
- PR was reviewed and approved by any necessary SMEs (subject matter experts)
- PR was reviewed and approved by a member of the Sentry docs team
Cursor Bugbot found 1 potential issue for commit 3da955a