Review documentation changes for compliance with the Metabase writing style guide. Use when reviewing pull requests, files, or diffs containing documentation markdown files.
npxskills add metabase/metabase--skill docs-reviewLoading…
@./../_shared/metabase-style-guide.md
IMPORTANT: Before starting the review, determine which mode to use:
PR review mode: If the mcp__github__create_pending_pull_request_review tool is available, you are reviewing a GitHub PR
Local review mode: If the MCP tool is NOT available, output issues in the conversation
mcp__github__create_pending_pull_request_review is availableRun through the diff looking for these issues:
Tone and voice:
Structure and clarity:
Links and references:
Formatting:
Code and examples:
Sentence construction:
| Pattern | Issue |
|---|---|
| we can do X, our feature | Should be "Metabase" or "it" |
| click here, read more here | Need descriptive link text |
| easy, simple, just | Remove condescending qualifiers |
| users | Should be "people" or "companies" if possible |
MANDATORY REQUIREMENT: Every single issue MUST be numbered sequentially starting from Issue 1.
This numbered format is NON-NEGOTIABLE. It allows users to efficiently reference specific issues (e.g., "fix issues 1, 3, and 5") and track which feedback has been addressed.
When outputting issues in the conversation (local mode), use this format:
## Issues
**Issue 1: [Brief title]**
Line X: Succinct description of the issue
[code or example]
Suggested fix or succinct explanation
**Issue 2: [Brief title]**
Line Y: Description of the issue
Suggested fix or explanation
**Issue 3: [Brief title]**
...
Examples:
Issue 1: Formal tone Line 15: This could be more conversational. Consider: "You can't..." instead of "You cannot..."
Issue 2: Vague heading Line 8: The heading could be more specific. Try stating the point directly: "Run migrations before upgrading" vs "Upgrade process"
When posting to GitHub (PR mode), use the pending review workflow:
Workflow steps:
Start a review: Use mcp__github__create_pending_pull_request_review to begin a pending review
Get diff information: Use mcp__github__get_pull_request_diff to understand the code changes and line numbers
Identify ALL issues: Read through all changes and identify every issue worth mentioning
Add review comments: Use mcp__github__add_pull_request_review_comment_to_pending_review for each issue
**Issue N: [Brief title]**Submit the review: Use mcp__github__submit_pending_pull_request_review to publish all comments at once
"COMMENT" (NOT "REQUEST_CHANGES") to make it non-blockingComment format example:
**Issue 1: Formal tone**
This could be more conversational. Consider: "You can't..." instead of "You cannot..."
IMPORTANT:
**Issue N: [Brief title]****Issue N: [Brief title]** where N is the issue number.
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Set up and use 1Password CLI (op). Use when installing the CLI, enabling desktop app integration, signing in (single or multi-account), or reading/injecting/running secrets via op.
CLI to manage emails via IMAP/SMTP. Use `himalaya` to list, read, write, reply, forward, search, and organize emails from the terminal. Supports multiple accounts and message composition with MML (MIME Meta Language).
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Set up and use 1Password CLI (op). Use when installing the CLI, enabling desktop app integration, signing in (single or multi-account), or reading/injecting/running secrets via op.
CLI to manage emails via IMAP/SMTP. Use `himalaya` to list, read, write, reply, forward, search, and organize emails from the terminal. Supports multiple accounts and message composition with MML (MIME Meta Language).