Skip to content

Commit 77ae6b8

Browse files
authored
[PR template] Add reminder to update Command Line Reference Guide if modifying user-facing commands (#569)
Add a reminder in the GitHub pull request template to update Command Line Reference Guide if modifying user-facing commands to ensure contributors keep the documentation up-to-date with new changes.
1 parent dc52015 commit 77ae6b8

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+5
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ If this is a bug fix, make sure your description includes "closes #xxxx",
88
"fixes #xxxx" or "resolves #xxxx" so that GitHub automatically closes the related
99
issue when the PR is merged
1010
11+
If you are modifying or removing an existing 'show', 'config' or 'sonic-clear'
12+
subcommand, or you are adding a new subcommand, please make sure you also
13+
update the Command Line Reference Guide (doc/Command-Reference.md) to reflect
14+
your changes.
15+
1116
Please provide the following information:
1217
-->
1318

0 commit comments

Comments
 (0)