From 28da85d57fbf1d0f42aa2ef248078f0f115e4b28 Mon Sep 17 00:00:00 2001 From: "Takagi, Isamu" Date: Wed, 15 Nov 2023 21:39:11 +0900 Subject: [PATCH 1/2] add word registration guidelines for spell check Signed-off-by: Takagi, Isamu --- docs/contributing/pull-request-guidelines/ci-checks.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/contributing/pull-request-guidelines/ci-checks.md b/docs/contributing/pull-request-guidelines/ci-checks.md index d09e4a17b00..53647200886 100644 --- a/docs/contributing/pull-request-guidelines/ci-checks.md +++ b/docs/contributing/pull-request-guidelines/ci-checks.md @@ -58,11 +58,15 @@ pre-commit run -a --config .pre-commit-config-optional.yaml ## spell-check-differential -This workflow detects spelling mistakes using [CSpell](https://github.com/streetsidesoftware/cspell) with [our dictionary file](https://github.com/tier4/autoware-spell-check-dict/blob/main/.cspell.json). -You can submit pull requests to [tier4/autoware-spell-check-dict](https://github.com/tier4/autoware-spell-check-dict) to update the dictionary. - +This workflow detects spelling mistakes using [CSpell](https://github.com/streetsidesoftware/cspell) with [our dictionary file](https://github.com/tier4/autoware-spell-check-dict/blob/main/.cspell.json). Since it is difficult to detect errors with no false positives, it is an optional workflow, but it is preferable to remove spelling mistakes as many as possible. +You have the following options if you need to use a word that is not registered in the dictionary. + +- If the word is only used in a few files, you can use [inline document settings "cspell:ignore"](https://cspell.org/configuration/document-settings/) to suppress the check. +- If the word is widely used in the repository, you can create a local cspell json and pass it to the [spell-check action](https://github.com/autowarefoundation/autoware-github-actions/tree/main/spell-check). +- If the word is common and may be used in many repositories, you can submit pull requests to [tier4/autoware-spell-check-dict](https://github.com/tier4/autoware-spell-check-dict) to update the dictionary. + ## build-and-test-differential This workflow checks `colcon build` and `colcon test` for the pull request. From e11ea6595c8310ada2aa43653ec3708d98921a32 Mon Sep 17 00:00:00 2001 From: "Takagi, Isamu" Date: Thu, 16 Nov 2023 13:29:18 +0900 Subject: [PATCH 2/2] add tier4/cspell-dicts Signed-off-by: Takagi, Isamu --- docs/contributing/pull-request-guidelines/ci-checks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/pull-request-guidelines/ci-checks.md b/docs/contributing/pull-request-guidelines/ci-checks.md index 53647200886..b242a58d9b9 100644 --- a/docs/contributing/pull-request-guidelines/ci-checks.md +++ b/docs/contributing/pull-request-guidelines/ci-checks.md @@ -65,7 +65,7 @@ You have the following options if you need to use a word that is not registered - If the word is only used in a few files, you can use [inline document settings "cspell:ignore"](https://cspell.org/configuration/document-settings/) to suppress the check. - If the word is widely used in the repository, you can create a local cspell json and pass it to the [spell-check action](https://github.com/autowarefoundation/autoware-github-actions/tree/main/spell-check). -- If the word is common and may be used in many repositories, you can submit pull requests to [tier4/autoware-spell-check-dict](https://github.com/tier4/autoware-spell-check-dict) to update the dictionary. +- If the word is common and may be used in many repositories, you can submit pull requests to [tier4/autoware-spell-check-dict](https://github.com/tier4/autoware-spell-check-dict) or [tier4/cspell-dicts](https://github.com/tier4/cspell-dicts) to update the dictionary. ## build-and-test-differential