Skip to content

Commit

Permalink
Mention options for correcting formatting issues when taking the "Qui…
Browse files Browse the repository at this point in the history
…ck fix" approach to contributing
  • Loading branch information
swar8080 committed Nov 22, 2023
1 parent 04da8d2 commit be7069b
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,16 @@ For small changes to a single file, you can edit directly in GitHub by clicking
**Edit this file** button. After forking the repository, follow the instructions
in [Editing files][].

For everything else, follow the
However, formatting may still be needed, like reducing line lengths in the
edited file. The options for fixing formatting are:

- Checking out the project and running the CLI scripts mentioned in
[Submitting a change](#submitting-a-change).
- Commenting `/fix:format` on your pull request to trigger an automated script.
This requires a unique branch name, which can be edited under _View all
branches_ in your fork.

For larger fixes, follow the
[instructions to setup a development environment](#development) below.

### PR Guidelines
Expand Down Expand Up @@ -212,8 +221,8 @@ The website is built from the following content:

### Submitting a change

Before submitting a to the repository, run the following command and address any
reported issues. Also commit any files changed by the `fix` script:
Before submitting a change to the repository, run the following command and
address any reported issues. Also commit any files changed by the `fix` script:

```sh
npm run test-and-fix
Expand Down

0 comments on commit be7069b

Please sign in to comment.