senzing-factory/build-resources#185 add spellcheck

.github/linters/.jscpd.json

@@ -1,3 +1,3 @@
 {
   "threshold": 13
-}
+}

.github/linters/.markdown-lint.yml

@@ -1,3 +1 @@
-{
-  "line-length": false
-}
+{ "line-length": false }

.github/workflows/spellcheck.yaml

@@ -0,0 +1,19 @@
+name: spellcheck
+
+on:
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  spellcheck:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: streetsidesoftware/cspell-action@v7
+        with:
+          config: .vscode/cspell.json

.gitignore

@@ -128,4 +128,8 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
+# Visual Studio code
+.vscode/*
+!.vscode/cspell.json
+*.code-workspace
 .history

.vscode/cspell.json

@@ -0,0 +1,41 @@
+{
+  "version": "0.2",
+  "language": "en",
+  "words": [
+    "amazonlinux",
+    "aptdownloader",
+    "arawinters",
+    "barrycaceres",
+    "CCLA",
+    "CODEOWNER",
+    "compressedfile",
+    "configmgr",
+    "configtables",
+    "configtool",
+    "configurator",
+    "createproject",
+    "dockerfiles",
+    "dockerhub",
+    "docktermj",
+    "dumpstack",
+    "gapper",
+    "gdev",
+    "ibmcom",
+    "ICLA",
+    "iniparams",
+    "kernelsam",
+    "mypy",
+    "pydev",
+    "pylint",
+    "redoer",
+    "Senzing",
+    "senzingapi",
+    "setupconfig",
+    "signingkey",
+    "stackoverflow",
+    "strerror",
+    "updateproject",
+    "venv"
+  ],
+  "ignorePaths": [".git/**", ".gitignore", ".mypy_cache/**", ".venv/**"]
+}

CODE_OF_CONDUCT.md

@@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
 
 Examples of behavior that contributes to creating a positive environment include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Our Responsibilities
 

CONTRIBUTING.md

@@ -14,9 +14,9 @@ There are a number of ways you can contribute:
 
 ## License Agreements
 
-If your contribution modifies the git repository, the following agreements must be established.
+If your contribution modifies the Git repository, the following agreements must be established.
 
-*Note:*  License agreements are only needed for adding, modifying, and deleting artifacts kept within the repository.
+_Note:_ License agreements are only needed for adding, modifying, and deleting artifacts kept within the repository.
 In simple terms, license agreements are needed before pull requests can be accepted.
 A license agreement is not needed for submitting feature request, bug reporting, or other project management.
 

examples/add-labels-standardized/README.md

@@ -1,31 +1,31 @@
-# Update git action file
+# Update Git action file
 
 ## Prerequisites
 
 1. Set these environment variable values:
 
-    ```console
-    export GIT_ACCOUNT=senzing
-    export GIT_REPOSITORY=github-util
-    export GIT_ACCOUNT_DIR=~/${GIT_ACCOUNT}.git
-    export GIT_REPOSITORY_DIR="${GIT_ACCOUNT_DIR}/${GIT_REPOSITORY}"
-    ```
+   ```console
+   export GIT_ACCOUNT=senzing
+   export GIT_REPOSITORY=github-util
+   export GIT_ACCOUNT_DIR=~/${GIT_ACCOUNT}.git
+   export GIT_REPOSITORY_DIR="${GIT_ACCOUNT_DIR}/${GIT_REPOSITORY}"
+   ```
 
 1. :pencil2: Set `GITHUB_ACCESS_TOKEN`.
    This is needed to access GitHub above the "public" limit.
    For information on how to obtain an access token, see
    [Creating a personal access token](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token).
 
-    ```console
-    export GITHUB_ACCESS_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-    ```
+   ```console
+   export GITHUB_ACCESS_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+   ```
 
 ## add-labels-standardized.sh
 
 1. Run `add-labels-standardized.sh`.
    Example:
 
-    ```console
-    cd ${GIT_REPOSITORY_DIR}/examples/add-labels-standardized
-    ./add-labels-standardized.sh
-    ```
+   ```console
+   cd ${GIT_REPOSITORY_DIR}/examples/add-labels-standardized
+   ./add-labels-standardized.sh
+   ```

examples/add-to-project/README.md

@@ -1,99 +1,99 @@
-# Update git action file
+# Update Git action file
 
 ## Prerequisites
 
 1. Set these environment variable values:
 
-    ```console
-    export GIT_ACCOUNT=<GITHUB_ORG>
-    export GIT_REPOSITORY=github-util
-    export GIT_ACCOUNT_DIR=~/${GIT_ACCOUNT}.git
-    export GIT_REPOSITORY_DIR="${GIT_ACCOUNT_DIR}/${GIT_REPOSITORY}"
-    ```
+   ```console
+   export GIT_ACCOUNT=<GITHUB_ORG>
+   export GIT_REPOSITORY=github-util
+   export GIT_ACCOUNT_DIR=~/${GIT_ACCOUNT}.git
+   export GIT_REPOSITORY_DIR="${GIT_ACCOUNT_DIR}/${GIT_REPOSITORY}"
+   ```
 
-    - Where `GITHUB_ORG` is one of `senzing`, `senzing-garage`, or `senzing-factory`
+   - Where `GITHUB_ORG` is one of `senzing`, `senzing-garage`, or `senzing-factory`
 
 1. :pencil2: Set `GITHUB_ACCESS_TOKEN`.
    This is needed to access GitHub above the "public" limit.
    For information on how to obtain an access token, see
    [Creating a personal access token].
 
-    ```console
-    export GITHUB_ACCESS_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-    ```
+   ```console
+   export GITHUB_ACCESS_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+   ```
 
 ## add-to-project.sh
 
 1. Run `add-to-project.sh` for `senzing-app-server`.
    Example:
 
-    ```console
-    cd ${GIT_REPOSITORY_DIR}/examples/add-to-project
+   ```console
+   cd ${GIT_REPOSITORY_DIR}/examples/add-to-project
 
-    export SENZING_TOPICS_INCLUDED=senzing-app-server
-    export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-app-server.yaml
+   export SENZING_TOPICS_INCLUDED=senzing-app-server
+   export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-app-server.yaml
 
-    ./add-to-project.sh
-    ```
+   ./add-to-project.sh
+   ```
 
 1. Run `add-to-project.sh` for `senzing-community`.
    Example:
 
-    ```console
-    cd ${GIT_REPOSITORY_DIR}/examples/add-to-project
+   ```console
+   cd ${GIT_REPOSITORY_DIR}/examples/add-to-project
 
-    export SENZING_TOPICS_INCLUDED=senzing-community
-    export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-community.yaml
+   export SENZING_TOPICS_INCLUDED=senzing-community
+   export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-community.yaml
 
-    ./add-to-project.sh
-    ```
+   ./add-to-project.sh
+   ```
 
 1. Run `add-to-project.sh` for `senzing-garage`.
    Example:
 
-    ```console
-    cd ${GIT_REPOSITORY_DIR}/examples/add-to-project
+   ```console
+   cd ${GIT_REPOSITORY_DIR}/examples/add-to-project
 
-    export SENZING_TOPICS_INCLUDED=senzing-garage
-    export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-garage.yaml
+   export SENZING_TOPICS_INCLUDED=senzing-garage
+   export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-garage.yaml
 
-    ./add-to-project.sh
-    ```
+   ./add-to-project.sh
+   ```
 
 1. Run `add-to-project.sh` for `senzing-g2-python`.
    Example:
 
-    ```console
-    cd ${GIT_REPOSITORY_DIR}/examples/add-to-project
+   ```console
+   cd ${GIT_REPOSITORY_DIR}/examples/add-to-project
 
-    export SENZING_TOPICS_INCLUDED=senzing-g2-python
-    export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-g2-python.yaml
+   export SENZING_TOPICS_INCLUDED=senzing-g2-python
+   export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-g2-python.yaml
 
-    ./add-to-project.sh
-    ```
+   ./add-to-project.sh
+   ```
 
 1. Run `add-to-project.sh` for `senzing-gdev`.
    Example:
 
-    ```console
-    cd ${GIT_REPOSITORY_DIR}/examples/add-to-project
+   ```console
+   cd ${GIT_REPOSITORY_DIR}/examples/add-to-project
 
-    export SENZING_TOPICS_INCLUDED=senzing-gdev
-    export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-gdev.yaml
+   export SENZING_TOPICS_INCLUDED=senzing-gdev
+   export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-gdev.yaml
 
-    ./add-to-project.sh
-    ```
+   ./add-to-project.sh
+   ```
 
 1. Run `add-to-project.sh` for `senzing-factory`.
    Example:
 
-    ```console
-    cd ${GIT_REPOSITORY_DIR}/examples/add-to-project
+   ```console
+   cd ${GIT_REPOSITORY_DIR}/examples/add-to-project
 
-    export SENZING_TOPICS_INCLUDED=senzing-factory
-    export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-factory.yaml
+   export SENZING_TOPICS_INCLUDED=senzing-factory
+   export ACTION_SOURCE_FILE=~/senzing.git/github-util/examples/add-to-project/add-to-project-factory.yaml
 
-    ./add-to-project.sh
-    ```
+   ./add-to-project.sh
+   ```
 
 [Creating a personal access token]: https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token