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

chore: make spellcheck script less noisy with --no-progress flag #3033

Merged

Conversation

petermetz
Copy link
Contributor

A quality of life improvement for contributors.

Prior to this the cspell tool that we invoke for spellchecking had listed every single file as a separate log line on standard output during it's execution and the files that had issues were marked in that list, but since we have more than a thousand files, it was a lot of scrolling and scanning to find the files that had spelling mistakes in them during development time.

With the --no-progress flag now passed in to cspell it will only print the files that were found to have spelling mistakes in them which makes contributor productivity a little better.

Pull Request Requirements

  • Rebased onto upstream/main branch and squashed into single commit to help maintainers review it more efficient and to avoid spaghetti git commit graphs that obfuscate which commit did exactly what change, when and, why.
  • Have git sign off at the end of commit message to avoid being marked red. You can add -s flag when using git commit command. You may refer to this link for more information.
  • Follow the Commit Linting specification. You may refer to this link for more information.

Character Limit

  • Pull Request Title and Commit Subject must not exceed 72 characters (including spaces and special characters).
  • Commit Message per line must not exceed 80 characters (including spaces and special characters).

A Must Read for Beginners
For rebasing and squashing, here's a must read guide for beginners.

Copy link
Contributor

@izuru0 izuru0 left a comment

Choose a reason for hiding this comment

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

LGTM

A quality of life improvement for contributors.

Prior to this the cspell tool that we invoke for spellchecking had
listed every single file as a separate log line on standard output
during it's execution and the files that had issues were marked in
that list, but since we have more than a thousand files, it was a lot
of scrolling and scanning to find the files that had spelling mistakes
in them during development time.

With the `--no-progress` flag now passed in to cspell it will only print
the files that were found to have spelling mistakes in them which makes
contributor productivity a little better.

Signed-off-by: Peter Somogyvari <[email protected]>
@petermetz petermetz force-pushed the build-cspell-no-progress-flag branch from 2551433 to fdf5402 Compare February 28, 2024 20:20
@petermetz petermetz enabled auto-merge (rebase) February 28, 2024 20:20
@petermetz petermetz merged commit f1b4146 into hyperledger-cacti:main Feb 28, 2024
130 of 147 checks passed
@petermetz petermetz deleted the build-cspell-no-progress-flag branch February 28, 2024 20:44
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.

3 participants