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

Multiple files: correct spelling #463

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

mkmer
Copy link
Collaborator

@mkmer mkmer commented Jan 21, 2025

Typos everywhere!
Correct spelling in multiple files.
Activate codespell on the repository
A user can run codespell -w --skip="./.git" --ignore-words=./dev/.codespellignore <file> check/fix a file locally before committing.

@mkmer mkmer marked this pull request as draft January 21, 2025 23:49
@mkmer mkmer force-pushed the spellcheck-activation branch from 01961ca to cf123ee Compare January 21, 2025 23:54
@mkmer mkmer marked this pull request as ready for review January 21, 2025 23:55
README.md Outdated Show resolved Hide resolved
apps/app_rpt/rpt_bridging.c Outdated Show resolved Hide resolved
.clang-format Outdated Show resolved Hide resolved
@mkmer mkmer force-pushed the spellcheck-activation branch 7 times, most recently from 6cd305d to f470965 Compare January 22, 2025 14:57
apps/app_gps.c Outdated Show resolved Hide resolved
@mkmer mkmer force-pushed the spellcheck-activation branch 3 times, most recently from 4bf5628 to 804decd Compare January 22, 2025 20:18
@encbar5
Copy link
Collaborator

encbar5 commented Jan 25, 2025

  1. If this pull request is focused on spelling, then the commit should probably not have the .clang-format file in it
  2. Why would we only check spelling on master? Why would we not check it on development branches?

@mkmer mkmer force-pushed the spellcheck-activation branch from 804decd to ed352fc Compare January 25, 2025 12:02
@mkmer
Copy link
Collaborator Author

mkmer commented Jan 25, 2025

  1. If this pull request is focused on spelling, then the commit should probably not have the .clang-format file in it

Fair point - I was working on both and this file "slipped' in. It really shouldn't be in this PR.

2. Why would we only check spelling on master? Why would we not check it on development branches?

Spelling is intended to be checked by the dev using the tools locally (or their brain -) ). This workflow is to confirm it is "right" before committing to the master branch.

Why would we not check it on development branches?

Master branch is all we have, maybe we should have a dev branch too? (I'm new here so I can't say for sure)
Releases are tagged in the Master, so we can always get back to specific released code.
Also, The Asterisk guys appear to run this way (with a tagged master rather than a dev branch).

It is a good question, I'll review the on push and on pull request directives.
PR looks right because master is all we PR typically.

activate codespell on the repo
@mkmer mkmer force-pushed the spellcheck-activation branch from ed352fc to 4afcfb3 Compare January 26, 2025 14:31
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.

5 participants