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

Spell Check added #20

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

Conversation

awanshahid1119
Copy link

spellcheck.sh:

Purpose: Automates spellchecking process using typos tool.
Usage: Execute bash scripts/spellcheck.sh to identify spelling errors in project files.
_typos.toml:

Purpose: Configurations for spellchecking process.
Usage: Customize options like file exclusions and word exceptions for accurate spellchecking.
spellcheck.yml:

Purpose: GitHub Actions workflow for CI spellchecking.
Usage: Automates spellchecking on pull requests, ensuring code quality with accurate spelling checks.

Comment on lines +3 to +10
"*.json",
"*.js",
"*.ipynb",
"src/zenml/zen_stores/migrations/versions/",
"tests/unit/materializers/test_built_in_materializer.py",
"tests/integration/functional/cli/test_pipeline.py",
"src/zenml/zen_server/dashboard/",
"examples/llm_finetuning/lit_gpt/"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These need updating. They relate to the core ZenML package, not this repository.

Comment on lines +6 to +7
# Run typos command with appropriate options
typos --config "$TYPOS_CONFIG" --write-changes
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we don't want to actually write changes. We just want to surface any errors for them to be manually corrected.

@strickvl strickvl added enhancement New feature or request CI labels Apr 4, 2024
@strickvl
Copy link
Collaborator

@awanshahid1119 just checking, are you able to resolve the conflicts and make the relevant changes requested?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants