Skip to content

Point the release grammar check at the writing skill's naming rules #1821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
katarinasupe wants to merge 1 commit into from
Closed

Point the release grammar check at the writing skill's naming rules #1821

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions skills/check-release-milestone/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,8 @@ Rules for this format:
- **Missing articles** ("creation of init container" → "creation of **an** init container").
- **Wrong word forms** ("set-up" used as a verb → "set up"; "additionally to" → "in addition to").
- **Stray punctuation** (accidental periods, double spaces in non-trailing positions).
- **Capitalization** - if the text is dealing with high availability and mentioning MAIN and REPLICA instances, use capital letters. When using in plural, write MAINs and REPLICAs.
- **Names and terms** that don't follow the writing rules engineers use, in the `write-docs-page` skill's `references/tone.md` (`memgraph/infra`, `agents/docs/skills/write-docs-page`): product names, MAIN and REPLICA in capitals (MAINs and REPLICAs in the plural), American English. Add a new naming rule there, not here, so docs written with the skill follow it too.

- Do **not** rewrite for style or restructure paragraphs. Only fix clear errors: misspellings, missing/wrong articles, broken grammar, and wrong word forms.
- Apply fixes directly, then list what was changed in the report.

Expand Down
Loading