Getting Started
Your First Review
What to expect when Brandlint reviews your first pull request.
Once you've installed Brandlint and chosen a voice template, you're ready to see it in action.
Opening a PR
Create a pull request that includes changes to user-facing copy. This could be:
- Button labels
- Form placeholders
- Error messages
- Headings or body text
- Tooltips
Brandlint automatically runs when the PR is opened or updated.
What you'll see
The GitHub Check
A check called Brandlint appears in your PR. It shows:
- Status — Pass or fail based on your threshold
- Score — How well your copy matches guidelines (0-100)
- Details link — Click to see specific suggestions
Inline suggestions
Each suggestion includes:
File: src/components/Button.tsx:42
Original: "Click here to submit"
Issue: Uses vague "click here" instead of describing the action
Suggested: "Submit your application"If the check fails
A failing check means your copy scored below the configured threshold (default: 70). You can:
- Review suggestions and update your copy
- Adjust the threshold in
brandlint.ymlif it's too strict - Ignore suggestions you disagree with — they're recommendations, not requirements
If there are no suggestions
If your PR passes with no suggestions, your copy is consistent with your brand guidelines. The check will show a green checkmark.