Skip to content

Commit d8bf25d

Browse files
committedMar 27, 2025·
Update Contributing docs with CSpell info
1 parent a77371a commit d8bf25d

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed
 

‎src/ScriptModuleRepositoryTemplate/TemplateRepoFiles/docs/Contributing.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ The code is built and tested by CI/CD pipelines on every commit to the `main` br
1515
When developing locally, you can use [the VS Code tasks](/.vscode/tasks.json) to simulate the build and test process and be notified of any problems before pushing your code up to the remote repository.
1616
In VS Code, open the command palette (Ctrl+Shift+P) and select `Tasks: Run Build Task` or `Tasks: Run Test Task`.
1717

18+
When you run the build task, it will run PSScriptAnalyzer and CSpell spellcheck.
19+
If CSpell flags a word as `unknown` that is not misspelled, you can add it to the `.cspell.json` file in the root of the repository to have it ignore the word.
20+
1821
## 🚀 Publishing new versions
1922

2023
A prerelease version of the module is published automatically on every commit to the `main` branch.

0 commit comments

Comments
 (0)
Please sign in to comment.