The contribution this repository accepts is a good issue. Vale CMS is closed-source, so there's no code here to patch — but a report that lets us reproduce a bug in one try is worth more than a patch we'd have to rewrite anyway.
Search existing issues first, including closed ones. A closed issue that describes your problem is worth commenting on — it tells us a fix regressed, or didn't cover your case.
Then check that it's actually a Vale CMS issue and not a Vale issue. If you can
reproduce it by running the vale CLI locally against the same files and
config, it's upstream: file it at
vale-cli/vale, where the people who
maintain the engine will see it.
- What you did, in enough detail to repeat. "Opened a rule, changed the
level, hit save" beats "saving broke." - What you expected, and what happened instead. Both, separately — the gap between them is usually the bug.
- The config or rule involved, pasted as text. A
.vale.inisnippet or the YAML of a single rule is ideal. Please strip anything private first. - Your browser and OS, if it's anything visual, an editor problem, or a crash.
- A screenshot or short recording, if it's a layout or rendering problem. For anything else, text is easier for us to search than an image.
Issues here are public and indexed by search engines. Never paste:
- Access tokens, API keys, or session cookies — GitHub, GitLab, AI provider, or ours.
- Private documents, or prose you can't share. Reduce it to the smallest sample that still reproduces the problem.
- Invoice numbers, email addresses, or anything else tied to your account. Billing questions go to hello@vale.sh instead.
If you've already posted a credential somewhere public, revoke it rather than deleting the comment — deleted content stays retrievable.
Don't open an issue for a vulnerability. Email hello@vale.sh; see SECURITY.md for what to include and what to expect back.
Describe the problem before the solution. "I maintain four repos that share a style and I have to update each one by hand" tells us more than "add a sync button" — it leaves room for a better answer than the one you had in mind, and it lets other people recognize their own situation and add to it.
Vale CMS is a commercial product with a small team, so an accepted request isn't a commitment to a date. We'll say plainly whether something is planned, unlikely, or already being worked on.
Be decent to each other. Reports of behaviour that isn't go to hello@vale.sh.
PRs against product code aren't possible here — that code isn't in this repo. PRs that fix a typo or a wrong link in these documents or the issue templates are welcome and will be merged.