Skip to content

Add a claude.md#3047

Open
MJRichardson wants to merge 1 commit intomainfrom
michrich/claude-md
Open

Add a claude.md#3047
MJRichardson wants to merge 1 commit intomainfrom
michrich/claude-md

Conversation

@MJRichardson
Copy link
Contributor

No description provided.


The spell checker uses `cspell` with a custom dictionary at `dictionary-octopus.txt`. Add new technical terms there when flagged.

**Flagged words** (must not use): `utilize`, `whilst`, `on-premise`, `whitelist`, `blacklist`, `enable/disable` (prefer `let`/`deactivate`), `within` (use `in`).

Choose a reason for hiding this comment

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

Suggested change
**Flagged words** (must not use): `utilize`, `whilst`, `on-premise`, `whitelist`, `blacklist`, `enable/disable` (prefer `let`/`deactivate`), `within` (use `in`).
There is spellcheck configuration in `./cspell.json`. In particular:
1. `flagWords` should never be used
2. We prefer to use the words on the right side of `->` in the list of `suggestWords`

@Steve-Fenton
Copy link

I've added a suggestion for the list of banned words. This would mean we don't need to keep updating the list for Claude if we update the cspell configuration. Would this work?

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