AI-powered brand voice checks in your GitHub workflow. Catch tone violations before they merge.
src/components/Button.tsx:12"Click here to continue"src/utils/errors.ts:5"An error was encountered by the system"Configure rules in your STYLE_GUIDE.md
Add one workflow file. Define your brand voice. Every PR gets checked automatically.
# .github/workflows/stringly-typed.yml
name: Stringly-Typed
on: [push, pull_request]
jobs:
brand-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: ddnetters/stringly-typed@v1
env:
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
with:
files: 'src/**/*.{ts,tsx}'
checker: 'brand_style'
style-guide-file: 'STYLE_GUIDE.md'Two files. That's all you need. Define your brand voice, add the workflow, done.
# Brand Voice## Tone- Use active voice, not passive- Be friendly but professional- Keep sentences under 20 words## Terminology- Say "customers" not "users"- Say "Select" not "Click"- Say "dashboard" not "admin panel"## Avoid- Jargon and buzzwords- Exclamation marks (except celebrations)- ALL CAPS for emphasis
Everything you need to customize Stringly-Typed for your workflow.
Everything you need to know before getting started.
We got tired of shipping copy that didn't match our style guide. Manual reviews were slow and inconsistent. So we automated the whole thing.
ddnetters
Creator of Stringly-Typed