-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document and enforce spelling policy
Define spelling for docs and spec as en_US. Add a CI job to enforce that and fix a couple of inconsistent spellings. A custom dictionary is maintained at .spellcheck-en-custom.txt Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com>
- Loading branch information
Showing
3 changed files
with
264 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # This is workflow for spell checking using PySpelling lib (https://pypi.org/project/pyspelling/) | ||
| name: Spellcheck | ||
| on: | ||
| pull_request: | ||
| branches: [ main ] | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| spellcheck: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: igsekor/pyspelling-any@v0.0.2 | ||
| name: Spellcheck |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,239 @@ | ||
| Auth | ||
| BD | ||
| CDEvent | ||
| CDEvents | ||
| CDF | ||
| CVE | ||
| CamelCase | ||
| CloudEvent | ||
| CloudEvents | ||
| Enum | ||
| FHbGphQ | ||
| FidWxhcnkgZGVmaW | ||
| Gerrit | ||
| Github | ||
| Gitlab | ||
| JSON | ||
| JXRmtaU | ||
| JoY | ||
| KH | ||
| KyjITcZXHotdMB | ||
| MEYCIQCBT | ||
| MergeRequest | ||
| MnY | ||
| MyPipeline | ||
| NGua | ||
| NIST | ||
| NZSh | ||
| Notational | ||
| PGRhdGE | ||
| PullRequest | ||
| QXFaWFpsYm | ||
| README | ||
| RIbHdaWE | ||
| RZ | ||
| RhdGE | ||
| SCM | ||
| SDKs | ||
| SIG | ||
| SKZ | ||
| SRE | ||
| Schemas | ||
| Tekton | ||
| TestOrg | ||
| TestRepo | ||
| TestSuite | ||
| URI | ||
| UUID | ||
| VGhlIHZvY | ||
| VZ | ||
| ViamVjdHMqCg | ||
| VkdobElIWnZZMkZpZFd | ||
| Whitepaper | ||
| WmlBcWMzVmlhbVZqZEhNcUNnPT | ||
| XiQlc | ||
| ZtYVc | ||
| aGNua | ||
| aGljaCBhcmUgbWFkZSBvZiAqc | ||
| aWhyZjVwb | ||
| aa | ||
| abc | ||
| abcde | ||
| aca | ||
| additionalProperties | ||
| aed | ||
| american | ||
| anUyNDRvazdkdWpfMjAyMjAyMjJUMTYwMDAwWiBhbmRyZWEuZnJpdHRvbGlAbQ | ||
| andrea | ||
| api | ||
| apis | ||
| artifactId | ||
| bGN | ||
| bd | ||
| bml | ||
| br | ||
| cSpell | ||
| cardpane | ||
| cb | ||
| cbdf | ||
| ccb | ||
| cd | ||
| cdeliveryfdn | ||
| cdevent | ||
| cdevents | ||
| cdfoundation | ||
| cdsystem | ||
| ce | ||
| charset | ||
| ci | ||
| cloudevents | ||
| clusterA | ||
| contentEncoding | ||
| contenttype | ||
| csrc | ||
| customData | ||
| customDataContentType | ||
| customDataEncoding | ||
| customdata | ||
| customdatacontenttype | ||
| daR | ||
| daemonset | ||
| datacontenttype | ||
| dataschema | ||
| datatracker | ||
| dbe | ||
| de | ||
| deterministically | ||
| dev | ||
| df | ||
| ece | ||
| emmitted | ||
| english | ||
| enum | ||
| eventdata | ||
| fas | ||
| fc | ||
| fd | ||
| featureBranch | ||
| frittoli | ||
| geo | ||
| github | ||
| githubusercontent | ||
| gmail | ||
| golang | ||
| href | ||
| html | ||
| http | ||
| https | ||
| iaas | ||
| ietf | ||
| img | ||
| interoperable | ||
| io | ||
| jenkins | ||
| json | ||
| jsonschemas | ||
| keptn | ||
| knative | ||
| lcyAqZXZlbnQgdHlwZXMqLCB | ||
| lifecycle | ||
| linkTitle | ||
| markdownlint | ||
| md | ||
| metricA | ||
| minLength | ||
| modelled | ||
| myApp | ||
| myChange | ||
| myPipeline | ||
| mySubject | ||
| myTask | ||
| myTestCaseRun | ||
| myTestSuiteRun | ||
| myapp | ||
| mycluster | ||
| mycr | ||
| mydata | ||
| mygit | ||
| myorg | ||
| myvalue | ||
| nWith | ||
| namespace | ||
| namespaceB | ||
| namespaces | ||
| nist | ||
| nnnn | ||
| notational | ||
| observability | ||
| oci | ||
| oneOf | ||
| outputType | ||
| param | ||
| pipelineName | ||
| pipelineRun | ||
| pipelinerun | ||
| png | ||
| pre | ||
| py | ||
| quicktime | ||
| repo | ||
| reportedBy | ||
| responseTime | ||
| rfc | ||
| rolledback | ||
| rst | ||
| runtime | ||
| schemas | ||
| scp | ||
| sdk | ||
| sha | ||
| sig | ||
| sigs | ||
| somewherelse | ||
| specversion | ||
| src | ||
| subjectid | ||
| svg | ||
| taskName | ||
| taskRun | ||
| taskrun | ||
| taskruns | ||
| teamX | ||
| tekton | ||
| testCase | ||
| testCaseRun | ||
| testCaseRuns | ||
| testEnv | ||
| testOutput | ||
| testSuite | ||
| testSuiteRun | ||
| testSuiteRuns | ||
| testSuiteXXX | ||
| testcase | ||
| testcaserun | ||
| testkube | ||
| testoutput | ||
| testrunreport | ||
| testsuite | ||
| testsuiterun | ||
| ticketURI | ||
| tmeid | ||
| tmsrc | ||
| toc | ||
| typesystem | ||
| unitest | ||
| uri | ||
| url | ||
| userId | ||
| utf | ||
| viewUrl | ||
| whl | ||
| wikipedia | ||
| wpaper | ||
| www | ||
| xTENCM | ||
| xml | ||
| ypDXWCjlNKfzTV | ||
| yshmiPmp | ||
| znnSMNkQIhAJ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| matrix: | ||
| - name: all | ||
| aspell: | ||
| lang: en | ||
| d: en_US | ||
| sources: | ||
| - "**/*.md" | ||
| - "**/*.json|!.github" | ||
| dictionary: | ||
| wordlists: | ||
| - .spellcheck-en-custom.txt |