Pr template: Added more help and a 'No release note' checkbox (#1541)

* Added a check box for no release notes for infrastructure, ctb, xilinx ctb, developer detector or linked PRs that have release notes; more help in comments with the checkboxes; removed detector labels checklist as its automated * minor * minor * minor * made it singular: no release note * review changes * typo * minor * minor * some more info * update
2026-09-07 19:42:37 +02:00 · 2026-08-25 15:43:16 +02:00
parent c55d2a33b6
commit d66c75f330
1 changed files with 72 additions and 26 deletions
@@ -1,48 +1,94 @@
+<!--
+Please review the checklist at the bottom before submitting. If ignored, the PR validation could fail.
+-->
+
 ## PR type

-**Select exactly one:**
+<details>
+<summary>PR types and its descriptions</summary>

+- 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.
+
+- Bug Fix PR:
+  - can be a bug fix to already released code.
+  - can be modifications to already released documentation regarding code.
+
+- 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.
+
+</details>
+
+**Select exactly one:**
+<!-- Selected: '[x]', Unselected: '[ ]' or Click when not in editing mode -->
 - [ ] Feature
 - [ ] Bug Fix
 - [ ] Infrastructure

 ## Breaking API

- [ ] This is a Breaking API change (Feature or Bug Fix).
+<details>
+<summary>Note</summary>
+
+Not affecting Infrastructure PRs.
+
+Breaking API includes:
+- API breaks
+- Not server-firmware API break
+- Major file version change (not just aare affected)
+</details>
+
+<!-- Selected: '[x]', Unselected: '[ ]' or Click when not in editing mode -->
+- [ ] This is a Breaking API change.

 ## Description
+<!-- Describe what this PR changes and why. -->

-<!--
-Describe what this PR changes and why.
-->
-
-## Equivalent PRs
-
-<!--
-Link any equivalent PRs in a release candidate or developer branch.
-eg. #1245
+## Referenced PRs
+<!-- Link any 
+- equivalent PRs in a release candidate or developer branch here
+- related PRs e.g. fixes/additions to an unreleased feature PR.
+eg. #1245 (prefix '#')
 -->

 ## Release notes

-<!--
-For Feature and Bug Fix PRs:
- - Describe the user-visible change introduced by this PR.
- - If the release note is provided by another PR, link that PR under 'Equivalent PRs" above.
+<details>
+<summary>Note</summary>

-Infrastructure PRs:
- - Do not require release notes.
-->
+Not affecting Infrastructure PRs.

-<!--
-### Checklist
+- 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
+</details>
+
+<!-- Selected: '[x]', Unselected: '[ ]' or Click when not in editing mode -->
+- [ ] No Release Note
+<!-- Describe the user-visible change introduced by this PR below. -->
+
+
+
+## Checklist:
+- I have chosen the primary PR type.

 Feature or Bug Fix PRs:
- [ ] I have checked whether this is a Breaking API change.
- [ ] I have provided a release note above or linked the PR containing it.
- [ ] I have labeled the detectors affected by this PR.
-
+- 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. 
+- 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 in a release candidate or developer branch.
-->
+- I have linked any equivalent PRs that is in an another branch.
+
+## Workflow
+- List of automation and validations can be found at https://psich.atlassian.net/wiki/x/AQB2P