How to contribute additional words in a particular dictionary?

[rostidev]

I've tried to figure out that by myself but failed to find the exact way of how to do that. Does this project maintain dictionaries by itself or just converts some external dictionary into a cspell binary format? Where are the dictionaries in any textual format, so I can contribute into there?

[Jason3S]

@rosti-il,

Thank you for asking. This repository is used to maintain the dictionaries. The source for each dictionary is generally in the form: dictionaries/<dictionary>/src/. Many of the natural language dictionaries come from other sources, a copy is made here to reduce outages.

See: CONTRIBUTING tries to explain how to add words.

Is there something you would like to add?

[CsatiZoltan]

@Jason3S I would like to add some terms into the scientific dictionary, but I have two questions:

1. Which of two files should I add?
2. What about splitting the scientific dictionary into several dictionaries by domain (e.g. mathematics, physics, biology, etc.). I don't have a strong opinion on this, both have advantages and drawbacks. Advantage of splitting: the number of scientific terms, as opposed to programming languages, is huge, which will significantly increase the file size. Drawback: some terms may belong to several scientific domains, moreover there are many hundreds of domains in science.

[Jason3S]

@Jason3S I would like to add some terms into the scientific dictionary, but I have two questions:

1. Which of two files should I add?

scientific_terms_US/src/additional_words.txt would be best. Its purpose is to be able to add words from the GitHub Web UI without needing to clone locally.

2. What about splitting the scientific dictionary into several dictionaries by domain (e.g. mathematics, physics, biology, etc.). I don't have a strong opinion on this, both have advantages and drawbacks. Advantage of splitting: the number of scientific terms, as opposed to programming languages, is huge, which will significantly increase the file size. Drawback: some terms may belong to several scientific domains, moreover there are many hundreds of domains in science.

I think it would be useful to split them. There isn't a problem with publishing multiple dictionaries.

[CsatiZoltan]

1. OK, I will do that. How often do you publish new releases?
2. Then I will need to create a new dictionary. Should I follow these guidelines?

[Jason3S]

1. OK, I will do that. How often do you publish new releases?

Generally within a day or two after the PR lands.

2. Then I will need to create a new dictionary. Should I follow these guidelines?

Wonderful.

In this case, I think it is better to just add the new files into the same location:

scientific_terms_US/src/mathematics.txt

And add a new "target" to the config:

scientific_terms_US/cspell-tools.config.yaml

# yaml-language-server: $schema=https://raw.githubusercontent.com/streetsidesoftware/cspell/main/packages/cspell-tools/cspell-tools.config.schema.json

targets:
  - name: custom_scientific_US
    targetDirectory: .
    compress: false
    format: trie3
    sources:
      - src/custom_scientific_US.dic.txt
      - src/additional_words.txt
    generateNonStrict: true
  - name: mathematics_US
    targetDirectory: .
    compress: false
    format: trie3
    sources:
      - src/mathematics.txt
    generateNonStrict: true
checksumFile: true

And update cspell-ext.json

    "dictionaryDefinitions": [
        {
            "name": "scientific-terms-us",
            "path": "./custom_scientific_US.trie.gz",
            "description": "Scientific Terms US dictionary."
        },
        {
            "name": "mathematics-terms-us",
            "path": "./mathematics.trie.gz",
            "description": "Mathematics Terms US dictionary."
        }
    ],

Something like that.

[CsatiZoltan]

PR #5215 submitted.