Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(core): Fix several misspellings #738

Merged
merged 2 commits into from
May 6, 2024
Merged

fix(core): Fix several misspellings #738

merged 2 commits into from
May 6, 2024

Conversation

b-long
Copy link
Contributor

@b-long b-long commented May 2, 2024

This PR fixes several misspellings.

Since doing this work manually seems like a waste of time, you might consider introducing automation to prevent spelling errors (I make them constantly).

One automatic spell-checker is https://github.com/codespell-project/codespell . It's very easy to run both locally and in CI, using pre-commit, e.g. the following will lint Go, Markdown, and YAML:

# To learn about "pre-commit", see:
#   https://github.com/pre-commit/pre-commit

repos:
-   repo: https://github.com/codespell-project/codespell
    rev: v2.2.6
    hooks:
    - id: codespell
      files: ^.*\.(go|md|yaml)$
      args: ["--write-changes", "--ignore-words-list", "MYCOOLWORD,ANOTHAONE"]

@b-long b-long requested review from a team as code owners May 2, 2024 18:54
@b-long b-long changed the title Introduce spellchecking (fix) Introduce spellchecking May 2, 2024
@b-long b-long changed the title (fix) Introduce spellchecking fix(core): Introduce spellchecking May 2, 2024
@jrschumacher
Copy link
Member

This is a great idea! We already use golangci-lint which has the ability to add misspell to check for spelling errors. I'd prefer to minimize the number of external tools if we can. Would you give this a try to see how it compares?

Also I'm not sure we want to introduce precommits as this will need to be a more detailed conversation. Precommits are great for small teams but large opensource projects they can become burdensome and many projects lean on CI linters.

.pre-commit-config.yaml Outdated Show resolved Hide resolved
.github/workflows/lint-all.yaml Outdated Show resolved Hide resolved
@b-long b-long changed the title fix(core): Introduce spellchecking fix(core): Fix several misspellings May 3, 2024
@b-long
Copy link
Contributor Author

b-long commented May 3, 2024

I've undone the addition of pre-commit. Sorry about that, I saw @jrschumacher 's comments before I pushed, and then saw @dmihalcik-virtru 's comments .

I did ask about this before I pushed, but didn't hear back earlier (see #736 🙊 🦗 )

My highest priority is to use the platform (work which has a deadline), so I'll let you all determine the best path forward in automation/linting. For now, this PR just fixes the existing spelling errors.

@dmihalcik-virtru dmihalcik-virtru added this pull request to the merge queue May 6, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks May 6, 2024
@b-long b-long added this pull request to the merge queue May 6, 2024
Merged via the queue into main with commit 8d61db3 May 6, 2024
16 checks passed
@b-long b-long deleted the bugfix/spelling branch May 6, 2024 13:38
github-merge-queue bot pushed a commit that referenced this pull request May 7, 2024
🤖 I have created a release *beep* *boop*
---


##
[0.4.1](service/v0.4.0...service/v0.4.1)
(2024-05-07)


### Features

* **core:** cors config
([#746](#746))
([3433b5b](3433b5b))
* **core:** Service Level Child Loggers
([#740](#740))
([aa0f210](aa0f210))
* **ers:** Create entity resolution service, replace idp plugin
([#660](#660))
([ff44112](ff44112))
* **sdk:** insecure plaintext and skip verify conn
([#670](#670))
([5c94d02](5c94d02))


### Bug Fixes

* **core:** Fix Lint
([#714](#714))
([2b0cb09](2b0cb09)),
closes [#701](#701)
* **core:** Fix several misspellings
([#738](#738))
([8d61db3](8d61db3))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: opentdf-automation[bot] <149537512+opentdf-automation[bot]@users.noreply.github.com>
github-merge-queue bot pushed a commit that referenced this pull request May 10, 2024
🤖 I have created a release *beep* *boop*
---


##
[0.2.1](sdk/v0.2.0...sdk/v0.2.1)
(2024-05-10)


### Features

* **sdk:** Adds TLS Certificate Exchange Flow
([#667](#667))
([0e59213](0e59213))
* **sdk:** insecure plaintext and skip verify conn
([#670](#670))
([5c94d02](5c94d02))


### Bug Fixes

* **core:** Fix Lint
([#714](#714))
([2b0cb09](2b0cb09)),
closes [#701](#701)
* **core:** Fix several misspellings
([#738](#738))
([8d61db3](8d61db3))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: opentdf-automation[bot] <149537512+opentdf-automation[bot]@users.noreply.github.com>
tech-guru42 added a commit to tech-guru42/TDF that referenced this pull request Jun 3, 2024
🤖 I have created a release *beep* *boop*
---


##
[0.4.1](opentdf/platform@service/v0.4.0...service/v0.4.1)
(2024-05-07)


### Features

* **core:** cors config
([#746](opentdf/platform#746))
([3433b5b](opentdf/platform@3433b5b))
* **core:** Service Level Child Loggers
([#740](opentdf/platform#740))
([aa0f210](opentdf/platform@aa0f210))
* **ers:** Create entity resolution service, replace idp plugin
([#660](opentdf/platform#660))
([ff44112](opentdf/platform@ff44112))
* **sdk:** insecure plaintext and skip verify conn
([#670](opentdf/platform#670))
([5c94d02](opentdf/platform@5c94d02))


### Bug Fixes

* **core:** Fix Lint
([#714](opentdf/platform#714))
([2b0cb09](opentdf/platform@2b0cb09)),
closes [#701](opentdf/platform#701)
* **core:** Fix several misspellings
([#738](opentdf/platform#738))
([8d61db3](opentdf/platform@8d61db3))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: opentdf-automation[bot] <149537512+opentdf-automation[bot]@users.noreply.github.com>
tech-guru42 added a commit to tech-guru42/TDF that referenced this pull request Jun 3, 2024
🤖 I have created a release *beep* *boop*
---


##
[0.2.1](opentdf/platform@sdk/v0.2.0...sdk/v0.2.1)
(2024-05-10)


### Features

* **sdk:** Adds TLS Certificate Exchange Flow
([#667](opentdf/platform#667))
([0e59213](opentdf/platform@0e59213))
* **sdk:** insecure plaintext and skip verify conn
([#670](opentdf/platform#670))
([5c94d02](opentdf/platform@5c94d02))


### Bug Fixes

* **core:** Fix Lint
([#714](opentdf/platform#714))
([2b0cb09](opentdf/platform@2b0cb09)),
closes [#701](opentdf/platform#701)
* **core:** Fix several misspellings
([#738](opentdf/platform#738))
([8d61db3](opentdf/platform@8d61db3))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: opentdf-automation[bot] <149537512+opentdf-automation[bot]@users.noreply.github.com>
passion-127 added a commit to passion-127/TDF that referenced this pull request Jun 6, 2024
🤖 I have created a release *beep* *boop*
---


##
[0.4.1](opentdf/platform@service/v0.4.0...service/v0.4.1)
(2024-05-07)


### Features

* **core:** cors config
([#746](opentdf/platform#746))
([3433b5b](opentdf/platform@3433b5b))
* **core:** Service Level Child Loggers
([#740](opentdf/platform#740))
([aa0f210](opentdf/platform@aa0f210))
* **ers:** Create entity resolution service, replace idp plugin
([#660](opentdf/platform#660))
([ff44112](opentdf/platform@ff44112))
* **sdk:** insecure plaintext and skip verify conn
([#670](opentdf/platform#670))
([5c94d02](opentdf/platform@5c94d02))


### Bug Fixes

* **core:** Fix Lint
([#714](opentdf/platform#714))
([2b0cb09](opentdf/platform@2b0cb09)),
closes [#701](opentdf/platform#701)
* **core:** Fix several misspellings
([#738](opentdf/platform#738))
([8d61db3](opentdf/platform@8d61db3))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: opentdf-automation[bot] <149537512+opentdf-automation[bot]@users.noreply.github.com>
passion-127 added a commit to passion-127/TDF that referenced this pull request Jun 6, 2024
🤖 I have created a release *beep* *boop*
---


##
[0.2.1](opentdf/platform@sdk/v0.2.0...sdk/v0.2.1)
(2024-05-10)


### Features

* **sdk:** Adds TLS Certificate Exchange Flow
([#667](opentdf/platform#667))
([0e59213](opentdf/platform@0e59213))
* **sdk:** insecure plaintext and skip verify conn
([#670](opentdf/platform#670))
([5c94d02](opentdf/platform@5c94d02))


### Bug Fixes

* **core:** Fix Lint
([#714](opentdf/platform#714))
([2b0cb09](opentdf/platform@2b0cb09)),
closes [#701](opentdf/platform#701)
* **core:** Fix several misspellings
([#738](opentdf/platform#738))
([8d61db3](opentdf/platform@8d61db3))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: opentdf-automation[bot] <149537512+opentdf-automation[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants