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

Create spellcheck.yml #92

Merged
merged 11 commits into from Jul 20, 2021
Merged

Create spellcheck.yml #92

merged 11 commits into from Jul 20, 2021

Conversation

quantum9Innovation
Copy link
Member

Run spellcheck on the entire repository using @check-spelling/check-spelling@v0.0.19.

Run spellcheck on the entire repository using @check-spelling/check-spelling@v0.0.19
@quantum9Innovation quantum9Innovation added feat 🚀 New feature or request low-priority 🔽 Will be worked on later labels Jul 19, 2021
@codecov
Copy link

codecov bot commented Jul 19, 2021

Codecov Report

Merging #92 (7adfcc8) into master (c5bc100) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #92   +/-   ##
=======================================
  Coverage   90.15%   90.15%           
=======================================
  Files           9        9           
  Lines         508      508           
=======================================
  Hits          458      458           
  Misses         50       50           
Impacted Files Coverage Δ
epispot/comps.py 96.03% <ø> (ø)
epispot/plots/native.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c5bc100...7adfcc8. Read the comment docs.

.github/workflows/spellcheck.yml Outdated Show resolved Hide resolved
spellcheck.yml updated to match standard template for @check-spelling/check-spelling
@quantum9Innovation
Copy link
Member Author

@Quantalabs indeed, we have ourselves quite a problem here:

github com-2021-07-19 16 36 31

@Quantalabs Quantalabs self-requested a review July 19, 2021 23:42
Copy link
Member

@Quantalabs Quantalabs left a comment

Choose a reason for hiding this comment

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

We have a long way to go... 🚀

.github/workflows/spellcheck.yml Show resolved Hide resolved
This commit adds a list of commonly used words in the repository to be
included in the dictionary for @check-spelling/check-spelling. The list
is limited to real words that would be used in a Markdown document
(other words will have to be dealt with differently).

Changelist:
Add list of allowed words: allow.txt to .github/actions/spelling

Additional Notes:
Recommendation (trivial):
Adding the allow.txt document to your local code editor's
spell-checking system is recommended so that your local setup is in
sync with the repo setup. That way, you won't be surprised when submitting
PRs and such things.
.github/actions/spelling configuration was added for the
@check-spelling/check-spelling action.

Changelist:
- .github/actions/spelling
  - Add allow.txt with new allowed words
  - Add excludes.txt to exclude files based on common glob patterns
  - Add patterns.txt to ignore URLs, paths, configs, etc.

Additional Notes:
Spelling (minor):
An additional expect.txt file will have to be added in order to
accommodate incorrect words found in files or comments will have to be
added to those lines.
`^\.github/action/spelling/` has been changed to:
`^\.github/actions/spelling/`
in .github/actions/spelling/excludes.txt
From @check-spelling/check-spelling

Changelist:
- .github/workflows/mod.yml (worflow → workflow)
- epispot/comps.py (susceptiblity → susceptibility,
  accomodating → accomodating)
- CONTRIBUTING.md (requeset → request)
- README.md (extesibility → extensibility)
@github-actions github-actions bot added the src Changes to the package source code label Jul 20, 2021
Fix all spelling errors and configuration, once and for all.

Changelist:
- .github/actions/spelling
  - Add `setuptools` to allow.txt
  - Exclude JPEG, CSV files, .gitignore, and binaries in excludes.txt
  - Create expects.txt
  - Ignore URLs and lines with `# spellcheck: disable` comments in
    patterns.txt
- Add `# spellcheck: disable` comments to remaining spellcheck errors
- Add `sdist` to expect.txt and reorder alphabetically
- Disable spellchecking on README URLs
These are the spelling errors that @check-spelling/check-spelling doesn't
warn about.

Changelist:
- .github/actions/spelling
    - Add `GPLv` to allow.txt
    - Add new words to expect.txt
- Add ignore comments in README.md, epispot/plots/native.py,
workflows/codeql-analysis.yml
@quantum9Innovation
Copy link
Member Author

Done! 🎉

@Quantalabs
Copy link
Member

:shipit:

@quantum9Innovation quantum9Innovation merged commit fbdf88e into master Jul 20, 2021
@quantum9Innovation quantum9Innovation deleted the check-spelling branch July 20, 2021 19:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat 🚀 New feature or request low-priority 🔽 Will be worked on later src Changes to the package source code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants