Skip to content

Commit 4ce6e9c

Browse files
committed
docs(file-format): add pre-commit documentation
Change-Id: I150470a903c69c1f516c5740011304d7f2d5fac2
1 parent a6c7968 commit 4ce6e9c

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

src/content/docs/configuration/file-format.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,19 @@ detailed description of the problem and guidance on how to fix it. Be sure to
231231
address any errors or warnings to ensure optimal performance and avoid
232232
potential issues.
233233

234+
### Validate Locally With Pre-Commit
235+
236+
To catch issues before pushing, you can validate your configuration locally
237+
using [Mergify's pre-commit hook](https://github.com/Mergifyio/mergify-pre-commit). Add this to your `.pre-commit-config.yaml`:
238+
239+
```yaml
240+
repos:
241+
- repo: https://github.com/Mergifyio/mergify-pre-commit
242+
rev: 1.0.0
243+
hooks:
244+
- id: validate-mergify-config
245+
```
246+
234247
### Troubleshooting
235248

236249
If you encounter issues or unexpected behavior with your Mergify configuration

0 commit comments

Comments
 (0)