From d9123bb231e8bd83cf23452c5dc8c3c5f6c9fa6e Mon Sep 17 00:00:00 2001 From: Oleksandr Ivantsiv Date: Wed, 20 May 2026 23:32:24 +0000 Subject: [PATCH] [chore/github]: Standardize GitHub PR description template Replace legacy templates with unified pull_request_template.md (description, type, approach, documentation). Signed-off-by: Oleksandr Ivantsiv --- .github/copilot-instructions.md | 5 +++ .github/pull_request_template.md | 66 +++++++++++++++----------------- 2 files changed, 36 insertions(+), 35 deletions(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 62b36c23a..9e69ad659 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -108,6 +108,11 @@ go tool cover -html=coverage.out - **Go formatting**: Code MUST pass `gofmt` - **Proto changes**: Update generated code when modifying `.proto` files - **Security**: gNMI server handles authentication — be security-conscious +- **PR description template**: Fill out all sections of the [PR template](.github/pull_request_template.md) when submitting a pull request: + - **Description of PR**: Summary of the change, motivation/context, reviewer entry point, and dependencies; reference issues with `fixes #xxxx` / `closes #xxxx`. + - **Type of change**: Mark the box(es) that apply — bug fix, new feature, refactor / cleanup, documentation update, test improvement. + - **Approach**: Motivation; how you did it; how you verified/tested it; any platform-specific notes. + - **Documentation**: Link to wiki / doc updates relevant to new features or test cases. ## Common Patterns diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index c02d193fb..f9372611b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,49 +1,45 @@ +### Description of PR + -#### Why I did it - -#### How I did it - -#### How to verify it +Summary: +Fixes # (issue) -#### Which release branch to backport (provide reason below if selected) +### Type of change -- [ ] 201811 -- [ ] 201911 -- [ ] 202006 -- [ ] 202012 -- [ ] 202106 -- [ ] 202111 +- [ ] Bug fix +- [ ] New feature +- [ ] Refactor / cleanup +- [ ] Documentation update +- [ ] Test improvement -#### Description for the changelog - +### Approach +#### What is the motivation for this PR? -#### Link to config_db schema for YANG module changes - +#### How did you do it? -#### A picture of a cute animal (not mandatory but encouraged) +#### How did you verify/test it? +#### Any platform specific information? + +### Documentation +