ci: add codespell spell-check workflow#417
ci: add codespell spell-check workflow#417dev-aditya-hub wants to merge 2 commits intokubeedge:mainfrom
Conversation
kubeedge-bot
added
the
do-not-merge/invalid-commit-message
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: dev-aditya-hub The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
kubeedge-bot
added
the
size/M
Add .github/workflows/spell-check.yml running codespell on every push and pull_request, and a .codespellrc limiting the check to core/. Fix all typos caught by the new check: - Deafult -> Default (log.py) - caculate -> calculate (federated_class_incremental_learning.py) - enviroment -> environment (simulation.py, simulation_system_admin.py) - segmantation -> segmentation (dataset.py) Signed-off-by: dev-aditya-hub <premjadhvar95@gmail.com>
dev-aditya-hub
force-pushed
the
ci/add-spell-check-workflow
branch
from
9b9abc1 to
8b321bc
Compare
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request corrects various spelling errors across the codebase, specifically targeting terms like "environment", "calculate", "default", and "segmentation". It also introduces a .codespellrc configuration file to help maintain spelling integrity. The review feedback suggests several improvements: aligning the .codespellrc skip list with its internal documentation, fixing a grammatical error in a log message, correcting the "destory" typo in a function name, and updating a docstring that incorrectly describes a destruction function as a build function.
| [codespell] | ||
| # examples/ and docs/proposals/ contain pre-existing issues from many | ||
| # contributors; they are tracked separately. CI focuses on core/ only. | ||
| skip = *.pyc,__pycache__,*.egg-info,.git |
There was a problem hiding this comment.
The configuration file mentions that examples/ and docs/proposals/ should be skipped, but they are not included in the skip list. Adding them here ensures that codespell behaves as intended even if run without explicit path arguments.
skip = *.pyc,__pycache__,*.egg-info,.git,examples,docs/proposals
| if build_simulation_env_ret.returncode == 0: | ||
| LOGGER.info( | ||
| "Congratulation! The simulation enviroment build successful!") | ||
| "Congratulation! The simulation environment build successful!") |
There was a problem hiding this comment.
This log message contains a typo ("Congratulation" should be "Congratulations") and the phrasing "build successful" is grammatically incomplete.
| "Congratulation! The simulation environment build successful!") | |
| "Congratulations! The simulation environment build was successful!") |
|
|
||
|
|
||
| def destory_simulation_enviroment(simulation): | ||
| def destory_simulation_environment(simulation): |
There was a problem hiding this comment.
The function name still contains the typo destory (should be destroy). Since this PR is already renaming the function (changing the suffix), it is an appropriate time to fix the prefix as well.
| def destory_simulation_environment(simulation): | |
| def destroy_simulation_environment(simulation): |
| def destory_simulation_environment(simulation): | ||
| """ | ||
| build the simulation enviroment | ||
| build the simulation environment |
There was a problem hiding this comment.
The docstring for the destruction function incorrectly states it "builds" the environment. It should be updated to reflect that it destroys or cleans up the environment.
| build the simulation environment | |
| destroy the simulation environment |
kubeedge-bot
removed
the
do-not-merge/invalid-commit-message
- "os" -> "of" in RuntimeError message (check_host_cpu) - rename destory_simulation_environment -> destroy_simulation_environment - fix docstring: "build" -> "destroy" for destroy_simulation_environment Signed-off-by: dev-aditya-hub <premjadhvar95@gmail.com>
|
/assign @MooreZheng |
3 participants
Summary
.github/workflows/spell-check.ymlthat runscodespellon everypushtomainand everypull_request, preventing new spelling errors from landing incore/.codespellrcto configure the check: scope iscore/only;examples/anddocs/proposals/contain pre-existing issues from many contributors and are tracked separatelycore/:Deafult→Default(core/common/log.py)caculate→calculate(federated_class_incremental_learning.py)enviroment→environment(simulation.py,simulation_system_admin.py)segmantation→segmentation(dataset.py)Why codespell
codespell is lightweight (pure Python, zero system deps), widely used in CNCF projects, and integrates in one
pip installstep — no extra Actions or third-party integrations required.Test plan
codespell --config .codespellrc coreexits 0 locally after applying the typo fixesFixes #232
Signed-off-by: dev-aditya-hub premjadhvar95@gmail.com