Skip to content

Commit c5270c5

Browse files
committed
how to update config docs
1 parent 9297271 commit c5270c5

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

CONTRIBUTING.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,11 @@ checklist are addressed in your PR.
2929
Use `pytest --cov=zappend --cov-report=html` to verify.
3030
* If your change affects the current project documentation,
3131
please adjust it and include the change in the PR.
32-
Run `mkdocs serve` to verify.
32+
Run `mkdocs serve` to verify.
33+
* The configuration reference `docs/config.md` is generated.
34+
Therefore, if you modify the `zappend` configuration,
35+
regenerate docs by `zappend --help-config md > docs/config.md`
36+
and verify the output.
3337

3438
## Code style
3539

0 commit comments

Comments
 (0)