Skip to content

Commit

Permalink
DOC Document linting documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
GuySartorelli committed Nov 9, 2023
1 parent d038f80 commit 97548bd
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions en/05_Contributing/02_Documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,26 @@ Once you've made the pull request, make sure the pull request follows the guidel

If you prefer to edit content on your local machine, follow the instructions on the [contributing code](code) page, since editing documentation on your computer follows that same process.

### Linting locally

When you submit your pull request, the documentation will be automatically linted. You may want to run this process locally. To do so, you'll need to have both [Composer](https://getcomposer.org/download/) and Yarn installed. See [client-side build tooling](/contributing/build_tooling/#installation) for yarn installation instructions.

You can then run the following commands from the command line to lint the documentation:

```bash
yarn install
composer install
yarn lint
```

If there are linting issues, you may find the output easier to work with by running the separate types of linting individually. You can find the commands for those inside the `package.json` file.

You can also fix any automatically fixable problems by passing the `--fix` option to the lint command.

```bash
yarn lint --fix
```

## Writing style

- Write in second person form, addressing the reader. For example "First you'll install a webserver" is good style.
Expand Down

0 comments on commit 97548bd

Please sign in to comment.