-
Notifications
You must be signed in to change notification settings - Fork 37
ci: ensures typos are caught during CI #257
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
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This pull request introduces typos checking into the CI pipeline to catch spelling errors automatically, while also fixing multiple spelling mistakes that already exist in the codebase. The PR includes tooling configuration, spelling corrections, and a standardized pull request template.
Changes:
- Added typos checker to pre-commit hooks and GitHub Actions CI workflow
- Fixed spelling errors throughout the codebase including "explicitly", "throttled", "separator", "configuration", "separated", and "automatically"
- Added pull request template to standardize contribution documentation
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
.typos.toml |
Configuration file for typos checker with custom dictionary to handle project-specific terms like proper names and intentional partial words |
.pre-commit-config.yaml |
Added typos hook (v1.42.0) to pre-commit configuration |
.github/workflows/lint.yml |
Added typos CI job using GitHub Actions (v1.29.5) |
.github/PULL_REQUEST_TEMPLATE.md |
Added standardized PR template for contributors |
cloudsmith_cli/core/tests/test_init.py |
Fixed typo: "explcitly" → "explicitly" |
cloudsmith_cli/core/ratelimits.py |
Fixed typo: "throtted" → "throttled" (important for API key matching) |
cloudsmith_cli/cli/tests/commands/test_repos.py |
Fixed typo: "seperator" → "separator" |
cloudsmith_cli/cli/config.py |
Fixed typo: "configuratin" → "configuration" |
cloudsmith_cli/cli/commands/metrics/packages.py |
Fixed typo: "seperated" → "separated" |
cloudsmith_cli/cli/commands/metrics/entitlements.py |
Fixed typo: "seperated" → "separated" |
CHANGELOG.md |
Fixed typo: "automaticlly" → "automatically" |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
53a5866 to
fcc5702
Compare
fcc5702 to
da5f494
Compare
BartoszBlizniak
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit-pick: Should we also include a template for issues?
What's Changed
This pull request introduces several improvements focused on code quality, documentation, and typo corrections. The main changes include adding a pull request template, integrating a spelling checker into the pre-commit workflow, and correcting various spelling mistakes across the codebase.
Documentation and Process Improvements
.github/PULL_REQUEST_TEMPLATE.mdto guide contributors in documenting their changes.Tooling Enhancements
typosspelling checker into the pre-commit configuration via.pre-commit-config.yamland added a custom dictionary in.typos.tomlto handle project-specific terms.Spelling and Typo Corrections