From 57da964b024a7948771ba6d1c265904a1f7bf4a6 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/PULL_REQUEST_TEMPLATE.md | 19 -------------- .github/copilot-instructions.md | 5 ++++ .github/pull_request_template.md | 45 ++++++++++++++++++++++++++++++++ 3 files changed, 50 insertions(+), 19 deletions(-) delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 05366e3ffab..00000000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,19 +0,0 @@ - - -**What I did** - -**Why I did it** - -**How I verified it** - -**Details if related** diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 581a93cea8b..7e8b04d23fb 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -104,6 +104,11 @@ sudo pytest -v test_route.py - **Testing**: Include mock tests for new orchagent features; VS tests for integration - **Single commit per PR**: Squash commits before merge - **Reference issues**: Link related GitHub issues in PR description +- **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 new file mode 100644 index 00000000000..f9372611bef --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,45 @@ + +### Description of PR + + +Summary: +Fixes # (issue) + +### Type of change + + + +- [ ] Bug fix +- [ ] New feature +- [ ] Refactor / cleanup +- [ ] Documentation update +- [ ] Test improvement + +### Approach +#### What is the motivation for this PR? + +#### How did you do it? + +#### How did you verify/test it? + +#### Any platform specific information? + +### Documentation +