From b3034f4ccb51ded80268875ebe86ce3ee27d17a0 Mon Sep 17 00:00:00 2001 From: Dhanya Thattil Date: Mon, 7 Sep 2026 15:51:03 +0200 Subject: [PATCH] pr template: removing det names (#1545) * Removing the keyword ctband xilinx_ctb from pr template because of the detector type workflow * clearer and removing det names * leave pr type unchecked * simpler * det names removed * again uncheck pr type * minor modifications * separate section for equivalent Prs * Added help section for equivalent and referneced PR sections --- .github/pull_request_template.md | 117 ++++++++++++++++++++++--------- 1 file changed, 84 insertions(+), 33 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 4756b0a43..44eacb521 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,28 +1,39 @@ +
+Help + +The following are managed automatically by workflow. Do not set them manually. +- Labels: Feature, Bug Fix, Infrastructure, Breaking API +- Milestone + +See PR Automation & Validation below for details. +
+ + + ## PR type
-PR types and its descriptions +Help - Feature PR: - - can be a Minor or Major change. - - can be an enhancement or change to existing features. - - can be a compilation or dependency change. - - can be a bug fix to a feature not released yet. - + - Minor/Major change + - Enhancement + - Compilation/dependency change + - Bug fix to an unreleased feature - Bug Fix PR: - - can be a bug fix to already released code. - - can be modifications to already released documentation regarding code. - + - Bug fix to released code + - Modifications to released documentation - Infrastructure PR: - - can be a workflows fix or change. - - can be a change in internal processes documentation. - - can be a helper script. - - can be a bug fix to an infrastructure not released yet. - + - Workflow/process change + - Helper script + - Internal documentation change + - Bug fix to unreleased infrastructure
**Select exactly one:** @@ -31,64 +42,104 @@ Please review the checklist at the bottom before submitting. If ignored, the PR - [ ] Bug Fix - [ ] Infrastructure + + ## Breaking API
-Note +Help Not affecting Infrastructure PRs. Breaking API includes: - API breaks - Not server-firmware API break -- Major file version change (not just aare affected) +- Major file version change
- [ ] This is a Breaking API change. + + ## Description + + +## Equivalent PRs +
+Help + +- Equivalent PR is a duplicated PR on another branch (RC or developer). +- If the current PR doesn't have any release notes, link the PR that does. +- Equivalent PRs in RC branches keep release notes instead of developer branch PRs. +
+ + + + + ## Referenced PRs - +
+Help + +- Referenced PR is any related PR. +- If the current PR doesn't have any release notes, link the PR that does. +- Eg. Current PR has no release notes when it is a bug fix to an unreleased feature PR that already has release notes. +
+ + + + ## Release notes
-Note +Help Not affecting Infrastructure PRs. -- Either check the 'No Release Note' if PR deals with: - - Ctb, Xilinx Ctb or developing detector - - a linked PR already including release notes for this PR -- Or write release notes +Choose one: +- Write release notes +- Check the 'No Release Note' if PR deals with: + - Chip test board type or developing detector + - an equivalent PR in release candidate branch with release notes for this PR + - a linked PR with release notes for this PR
- [ ] No Release Note - + ## Checklist: + +
+Before submitting + - I have chosen the primary PR type. Feature or Bug Fix PRs: - I have checked if this is a Breaking API change. - I have linked any - - equivalent PRs that is on another branch. - - related PRs eg. fixes/additions to an unrelease feature PR. + - equivalent PRs that are on another branch. + - related PRs eg. fixes/additions to an unreleased feature PR. - I have provided a release note above or checked 'No Release Note'. - I have added detector labels. Some automation in adding labels from code change and PR description. Infrastructure PRs: -- I have linked any equivalent PRs that is in an another branch. +- I have linked any equivalent PRs that are in another branch. -## Workflow -- List of automation and validations can be found at https://psich.atlassian.net/wiki/x/AQB2P \ No newline at end of file +
+ + + +## PR Automation & Validation +
+Additional Information + +List of automation and validations can be found at https://psich.atlassian.net/wiki/x/AQB2P + +
\ No newline at end of file