-
Notifications
You must be signed in to change notification settings - Fork 28
chore: Add GitHub Action for spell checking with cspell #405
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
base: main
Are you sure you want to change the base?
Conversation
Co-authored-by: marcoscaceres <870154+marcoscaceres@users.noreply.github.com>
|
@copilot, can you make the commit message start with "chore: "? |
I'm unable to amend existing commit messages since that would require force pushing, which isn't available in my environment. The commit message convention could be applied when squash-merging this PR - GitHub allows you to edit the final commit message during the merge. |
|
@copilot, no problem. Will fix it when I merge. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds automated spell checking to the repository using GitHub Actions. It leverages the existing cspell configuration (cspell.json and .cspell/ custom dictionaries) to check spelling on pull requests and pushes to the main branch.
Key Changes:
- Creates a new GitHub Actions workflow that runs cspell using the
streetsidesoftware/cspell-action@v6 - Configures the workflow to check all HTML and Markdown files across the repository
- Implements minimal permissions (
contents: read) following security best practices
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@copilot, can you also update CONTRIBUTING.md with instructions of how to use cspell with Visual Studio Code? Can you verify if you need to install "Code Spell Checker" https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker |
Co-authored-by: marcoscaceres <870154+marcoscaceres@users.noreply.github.com>
Done in 33e2768. Added instructions to CONTRIBUTING.md for using cspell with VS Code. Yes, the "Code Spell Checker" extension is required - it's the VS Code integration for cspell and automatically reads the |
|
|
||
| This repository is being used for work in the W3C Federated Identity on the Web Working Group, governed by the [W3C Patent Policy](http://www.w3.org/Consortium/Patent-Policy-20040205/) and | ||
| [Spftware and Document License](https://www.w3.org/copyright/software-license-2023/). To contribute, you must | ||
| [Software and Document License](https://www.w3.org/copyright/software-license-2023/). To contribute, you must |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hehe, it works! 🥳
Closes #147
Adds a GitHub Actions workflow to run cspell on pull requests and pushes to main. Uses the existing
cspell.jsonconfiguration and.cspell/custom dictionaries already in the repository..github/workflows/spellcheck.ymlusingstreetsidesoftware/cspell-action@v6.htmland.mdfilespermissions: contents: readper security best practicesCONTRIBUTING.mdwith instructions for using cspell with Visual Studio Code (Code Spell Checker extension)CONTRIBUTING.md("Spftware" → "Software")The following tasks have been completed:
Implementation commitment:
Documentation and checks
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.