cspell-dicts icon indicating copy to clipboard operation
cspell-dicts copied to clipboard

Docs on processes for proposing words?

Open JoshuaKGoldberg opened this issue 1 year ago • 1 comments

Separately from docs on actually adding words (#3857), it'd be great to document the process by which we're meant to add words. Do you want us to file an issue? Just send a PR? What's the criteria for inclusion either way?

Context: I have some words (automerge, tada, wontfix, etc.) that I think should be included in some dictionaries, but don't know the right way to ideate them here.

JoshuaKGoldberg avatar Dec 04 '24 01:12 JoshuaKGoldberg

@JoshuaKGoldberg,

Good point.

Quick Answer: For word additions, I prefer a PR over an issue + PR. I have tried to setup the repo so that PR can be done right from the GitHub UI, no need to copy to your own machine and build.

In your case, I think the words can go into dictionaries/software-terms/src/coding-terms.txt.

For words associated with a particular programming language / environment, they should go in the appropriate dictionary.

Jason3S avatar Dec 12 '24 08:12 Jason3S