From 77ae6b8676e3bb4ae0fe21765e69879a6a53d642 Mon Sep 17 00:00:00 2001 From: Joe LeVeque Date: Wed, 3 Jul 2019 11:17:36 -0700 Subject: [PATCH] [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. --- .github/PULL_REQUEST_TEMPLATE.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index adaefd2d438c..03a0f5ff79f5 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -8,6 +8,11 @@ If this is a bug fix, make sure your description includes "closes #xxxx", "fixes #xxxx" or "resolves #xxxx" so that GitHub automatically closes the related issue when the PR is merged +If you are modifying or removing an existing 'show', 'config' or 'sonic-clear' +subcommand, or you are adding a new subcommand, please make sure you also +update the Command Line Reference Guide (doc/Command-Reference.md) to reflect +your changes. + Please provide the following information: -->