Skip to content

[RULE]: Add words to avoid rule to linter - #53

Merged
JC-DSIT merged 9 commits into
mainfrom
rule/words-to-avoid
Jun 10, 2026
Merged

[RULE]: Add words to avoid rule to linter#53
JC-DSIT merged 9 commits into
mainfrom
rule/words-to-avoid

Conversation

@JC-DSIT

@JC-DSIT JC-DSIT commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

Proposed changes

  • add words-to-avoid.yml
  • update README.md
  • add words-to-avoid-unless.yml rule
  • add BDD tests

Adds two new linting rules:

  • words-to-avoid which raises an error for any of the straightforward words to avoid (e.g. initiate, use ‘start’ or ‘begin’)
  • words-to-avoid-unless which raises a warning if there is a time it may be used (e.g. slim down (unless talking about one’s waistline), use ‘make smaller’ or ‘reduce the size’)

What changed

Adds new rules, extends the linter coverage and the ability to consistently highlight and review content.

Related issue or tracking reference

You should have an open GitHub issue that this PR will fix.

Related feature files

To help us understand the change, please either list or link to any feature files or scenarios that explain the new behaviour

TBC

Checklist

Before you request approval you should confirm that:

  • the pull request has a clear title with a short description about the update in the documentation
  • you have added, updated or removed any scenarios affected by the change
  • GitHub actions all pass
  • you have linked this PR to an issue (or explained why none exists)
  • you have updated documentation if needed

- add words-to-avoid.yml
- update README.md
@JC-DSIT JC-DSIT linked an issue Jun 4, 2026 that may be closed by this pull request
3 tasks
Comment thread features/style_guide/WordsToAvoid.feature Outdated
Comment thread features/style_guide/WordsToAvoid.feature
CarrJ and others added 4 commits June 9, 2026 20:41
Co-authored-by: Nathan Driver <80888259+NathanD-GDS@users.noreply.github.com>
# Conflicts:
#	Gemfile
#	Gemfile.lock
@JC-DSIT
JC-DSIT merged commit 9083285 into main Jun 10, 2026
1 check passed
jonnyandrew added a commit to govuk-one-login/mobile-android-ui that referenced this pull request Jun 11, 2026
jonnyandrew added a commit to govuk-one-login/mobile-android-networking that referenced this pull request Jun 11, 2026
jonnyandrew added a commit to govuk-one-login/mobile-android-logging that referenced this pull request Jun 11, 2026
@JC-DSIT JC-DSIT mentioned this pull request Jun 30, 2026
5 tasks
@JC-DSIT
JC-DSIT deleted the rule/words-to-avoid branch September 10, 2026 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Rule]: Highlight use of words to avoid

3 participants