-
Notifications
You must be signed in to change notification settings - Fork 98
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
Rewrite README to use ./check
and ./fix
#2847
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
@beckykd @abbycross review appreciated on the README and the error messages I put in the PR description. |
abbycross
reviewed
Mar 24, 2025
abbycross
reviewed
Mar 24, 2025
abbycross
approved these changes
Mar 24, 2025
arnaucasau
approved these changes
Mar 25, 2025
Co-authored-by: Abby Cross <[email protected]>
frankharkins
pushed a commit
that referenced
this pull request
Apr 1, 2025
Part of #2800. We don't want contributors to have to know what the different checks are. They should simply run `./check` and `./fix` and we handle it all for them. If something breaks, we should say in the error message how to fix things. ### Adds instructions to spellcheck We now tell you how to fix the problem, whereas before you had to read the README. MDX: ``` ❯ npm run check:spelling > [email protected] check:spelling > tsx scripts/js/commands/checkSpelling.ts docs/guides/index.mdx:6:19 - Unknown word (Qiskitttt) CSpell: Files checked: 91, Issues found: 1 in 1 file. --------------- 🙅 There are unrecognized words (see above). If the word is a not a typo, there are two ways to allowlist it: 1. Add a comment on a dedicated line near the top of the MDX file, between the page metadata and the H1 heading, such as: {/* cspell:ignore hellllooooo, ayyyyy */} 2. If you expect this word to appear in other files, add it to a dictionary. Add names to the `scripts/config/cspell/dictionaries/people.txt` file. Add scientific or quantum specific words to the `scripts/config/cspell/dictionaries/qiskit.txt` file. If it doesn't fit in either category, add it to the `words` section in `scripts/config/cspell/cSpell. json`. The word is not case-sensitive. ``` Jupyter: ``` ❯ npm run check:spelling > [email protected] check:spelling > tsx scripts/js/commands/checkSpelling.ts CSpell: Files checked: 91, Issues found: 0 in 0 files. ❌ Unrecognized word in docs/guides/hello-world.ipynb: worlddddd --------------- 🙅 There are unrecognized words (see above). If the word is a not a typo, there are two ways to allowlist it: 1. Add a comment on a dedicated line to the first markdown cell in the Jupyter notebook. (This cell should have the page title.) For example, add the following above the H1 heading: {/* cspell:ignore helloooooo */} 2. If you expect this word to appear in other files, add it to a dictionary. Add names to the `scripts/config/cspell/dictionaries/people.txt` file. Add scientific or quantum specific words to the `scripts/config/cspell/dictionaries/qiskit.txt` file. If it doesn't fit in either category, add it to the `words` section in `scripts/config/cspell/cSpell. json`. The word is not case-sensitive. ``` --------- Co-authored-by: Abby Cross <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of #2800.
We don't want contributors to have to know what the different checks are. They should simply run
./check
and./fix
and we handle it all for them. If something breaks, we should say in the error message how to fix things.Adds instructions to spellcheck
We now tell you how to fix the problem, whereas before you had to read the README.
MDX:
Jupyter: