From d4f68ebb49cf8163980d6ed025dc9c415b849889 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 | 8 +++--- .github/pull_request_template.md | 49 +++++++++++++++++++++++--------- 2 files changed, 40 insertions(+), 17 deletions(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 4030ab501..a03c80cf6 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -105,10 +105,10 @@ pytest tests/ --cov --cov-report=term-missing - **Platform compatibility**: Changes must not break any vendor platform - **DB schema**: Document any STATE_DB table changes - **PR description template**: Fill out all sections of the [PR template](.github/pull_request_template.md) when submitting a pull request: - - **Description**: Describe your changes in detail - - **Motivation and Context**: Why is this change required? What problem does it solve? Reference issues with "fixes #xxxx" - - **How Has This Been Tested?**: Describe how you tested your changes, including test environment and tests run - - **Additional Information**: Any other relevant details (optional) + - **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 ee5b33361..f9372611b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,22 +1,45 @@ - + +### Description of PR -#### Motivation and Context +Summary: +Fixes # (issue) + +### Type of change + -#### How Has This Been Tested? +- [ ] 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 - -#### Additional Information (Optional)