Skip to content
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.

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

Check spelling for PRs #2017

Merged
merged 10 commits into from
Oct 17, 2023
Merged

Check spelling for PRs #2017

merged 10 commits into from
Oct 17, 2023

Conversation

steve-fenton-octopus
Copy link
Contributor

@steve-fenton-octopus steve-fenton-octopus commented Oct 2, 2023

Currently under RFC.

Adds spell checking as a required check, but only for files changed in the PR.

  • .github/workflows/branch-spellcheck.yaml is the GitHub Action for the check (runs in < 1 minute)
  • cspell.json contains configuration for the spell-check action (and will home additional vocab)
  • package.json has the cspell package dependency

Additionally:

  • .vscode/settings.json is to help authors using VSCode with the Code Spell Checker extension - we should look to sync this with the cspell.json to ensure a green light locally will maximize the change of a green light on commit.

@steve-fenton-octopus steve-fenton-octopus changed the title Sf/spelling package Check spelling for PRs Oct 4, 2023
@steve-fenton-octopus steve-fenton-octopus marked this pull request as ready for review October 17, 2023 10:27
@steve-fenton-octopus
Copy link
Contributor Author

RFC process completed on 15th October with no objections.

Copy link
Contributor

@tonykelly-octopus tonykelly-octopus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@steve-fenton-octopus steve-fenton-octopus merged commit c400efd into main Oct 17, 2023
4 checks passed
@steve-fenton-octopus steve-fenton-octopus deleted the sf/spelling-package branch October 17, 2023 11:20
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.

2 participants