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

Rewrite README to use ./check and ./fix #2847

Merged
merged 2 commits into from
Mar 25, 2025
Merged

Conversation

Eric-Arellano
Copy link
Collaborator

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.

@Eric-Arellano
Copy link
Collaborator Author

@beckykd @abbycross review appreciated on the README and the error messages I put in the PR description.

Co-authored-by: Abby Cross <[email protected]>
@Eric-Arellano Eric-Arellano added this pull request to the merge queue Mar 25, 2025
Merged via the queue into main with commit 2bc4dc1 Mar 25, 2025
3 checks passed
@Eric-Arellano Eric-Arellano deleted the EA/rewrite-readme branch March 25, 2025 14:13
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
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants