Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR standardizes documentation to British English, introduces a new Vale-based linting guide, and refactors Vale configuration and custom style rules.
- Converted existing docs to British spelling and terminology
- Added
linting-prose-with-vale/index.qmdas a Vale intro - Updated
.vale.ini,.typos.toml, and custom.github/stylesrules for Vale
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| turbocharging-your-github-organisation/index.qmd | Updated to British spelling (customise, organisation, visualise, centralised) |
| linting-prose-with-vale/index.qmd | Added a new Vale presentation deck |
| .vale.ini | Changed Vale.Spelling from a boolean to NO |
| .typos.toml | Extended typo words with promis and yse |
| .github/styles/custom/spaces.yml | Reformatted message field, removed link |
| .github/styles/custom/oxford-comma.yml | Reformatted message field, removed link |
| .github/styles/custom/endash.yml | Converted message to block scalar, removed link |
| .github/styles/custom/dashes.yml | Reformatted message field, removed link |
| .github/styles/custom/british-spellings.yml | Expanded and reorganized UK/US spelling mappings |
Comments suppressed due to low confidence (1)
.vale.ini:15
- The
Vale.Spellingsetting expects a boolean (true/false), notNO. Revert tofalseor use a valid boolean literal.
Vale.Spelling = NO
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
This PR localizes several guides to British English, adds a new "Linting Prose with Vale" slide deck, and updates Vale/typo configurations and custom rules.
- Updated QMD content with British/Australian spelling.
- Added a full new presentation (
linting-prose-with-vale/index.qmd) on using Vale. - Adjusted Vale and typo config files and introduced custom Vale style rules.
Reviewed Changes
Copilot reviewed 22 out of 22 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| turbocharging-your-github-organisation/index.qmd | Changed US to British spelling (customise, visualise, organisation) |
| pyopensci-my-experience/index.qmd | Minor punctuation tweak (e.g.) |
| linting-prose-with-vale/index.qmd | New Vale talk slide deck |
| .vale.ini | Swapped false → NO for Vale.Spelling |
| .typos.toml | Added custom typo words (promis, yse) |
| .github/styles/custom/spaces.yml | Reformatted rule; link key removed |
| .github/styles/custom/quotes.yml | Added YAML docstart |
| .github/styles/custom/oxford-comma.yml | Added YAML docstart |
| .github/styles/custom/endash.yml | Added YAML docstart |
| .github/styles/custom/dashes.yml | Added YAML docstart |
| .github/styles/.gitignore | Tracking for custom Vale rules |
Comments suppressed due to low confidence (7)
.github/styles/custom/spaces.yml:1
- Vale style files should not start with a YAML document marker (
---). Remove this line to ensure Vale parses the rule correctly.
---
.github/styles/custom/quotes.yml:1
- Vale style files should not include a YAML document marker (
---). Please remove it so the rule is loaded properly.
---
.github/styles/custom/oxford-comma.yml:1
- Leading
---is not needed in Vale rule files and may break parsing; remove the document marker.
---
.github/styles/custom/endash.yml:1
- Remove the YAML frontmatter marker (
---) from this Vale rule file to maintain correct syntax.
---
.github/styles/custom/dashes.yml:1
- Vale custom rules should not start with
---; please delete this line to avoid parse errors.
---
.github/styles/custom/spaces.yml:3
- [nitpick] The
linkfield was removed from this rule. If you still intend to provide a reference URL for contributors, re-add alinkkey.
message: Use only one space between words and sentences (not two).
.vale.ini:15
- Vale expects boolean values (
true/false) for settings. ChangeNOback tofalseto ensure the rule is disabled.
Vale.Spelling = NO
Prompted by discussions at https://www.software.ac.uk/workshop/collaborations-workshop-2025-cw25