Skip to content

Commit 35ef6cb

Browse files
committed
docs(pull_request_template): add broken link check to the checklist
1 parent cb589d8 commit 35ef6cb

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

.github/pull_request_template.md

+7
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,13 @@ Please fill in the following content to let us know better about this change.
2525
### Documentation Changes
2626

2727
- [ ] Run `poetry doc` locally to ensure the documentation pages renders correctly
28+
- [ ] Check if there are any broken links in the documentation
29+
30+
> When running `poetry doc`, any broken internal documentation links will be reported in the console output like this:
31+
>
32+
> ```text
33+
> INFO - Doc file 'config.md' contains a link 'commands/bump.md#-post_bump_hooks', but the doc 'commands/bump.md' does not contain an anchor '#-post_bump_hooks'.
34+
> ```
2835
2936
## Expected Behavior
3037
<!-- A clear and concise description of what you expected to happen -->

0 commit comments

Comments
 (0)