Skip to content

Commit 6bb3942

Browse files
committed
Add instructions on how to run yamllint
We want to start linting the YAML files using it.
1 parent 684e157 commit 6bb3942

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,3 +173,14 @@ In some places of the framework we support basic [markdown formatting](https://g
173173
1. Increase the version number in the package.json `name` property to match the new version. This is to support the method needed to cater for multiple versions of the framework in the [frontend project](https://github.com/ministryofjustice/hmpps-book-secure-move-frontend/blob/d374ac9e46f0e258ec2a9fa1bbc9a7df2fb81cc4/package.json#L70-L71).
174174
1. Push the commit to the remote server (`git push`)
175175
1. Push tags to remote (`git push --tags`)
176+
177+
## Linting
178+
179+
We use [yamllint] to lint the YAML files. [Once installed][yamllint-installation], you can check all the files are linted correctly by running:
180+
181+
```shell
182+
$ yamllint .
183+
```
184+
185+
[yamllint]: https://yamllint.readthedocs.io/en/stable/index.html
186+
[yamllint-installation]: https://yamllint.readthedocs.io/en/stable/quickstart.html#installing-yamllint

0 commit comments

Comments
 (0)