Skip to content

Commit

Permalink
Specify command to run Prettier (Qiskit#1245)
Browse files Browse the repository at this point in the history
Clarify the options for fixing a file with a Prettier error.

---------

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
  • Loading branch information
abbycross and Eric-Arellano authored Apr 26, 2024
1 parent 4cd9729 commit 631be2c
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -308,9 +308,9 @@ You can also check that API docs and translations render by using any of these a

CI will check on every PR that any changed files render correctly. We also run a weekly cron job to check that every page renders correctly.

## Format TypeScript files
## Format README and TypeScript files

If you're working on our support code in `scripts/`, run `npm run fmt` to automatically format the files.
Run `npm run fmt` to automatically format the README, `.github` folder, and `scripts/` folder. You should run this command if you get the error in CI `run Prettier to fix`.

To check that formatting is valid without actually making changes, run `npm run check:fmt` or `npm run check`.

Expand Down

0 comments on commit 631be2c

Please sign in to comment.