mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2026-11-09 10:23:52 +01:00
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
This commit is contained in:
1 parent
d66c75f330
commit
b3034f4ccb
1 file changed
+84
-33
@@ -1,28 +1,39 @@
|
||||
<!--
|
||||
Please review the checklist at the bottom before submitting. If ignored, the PR validation could fail.
|
||||
Please complete all relevant sections. If not, validation could fail.
|
||||
|
||||
The expandable sections are guidance only — do not modify or fill them out.
|
||||
-->
|
||||
|
||||
<details>
|
||||
<summary>Help</summary>
|
||||
|
||||
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.
|
||||
</details>
|
||||
|
||||
|
||||
|
||||
## PR type
|
||||
|
||||
<details>
|
||||
<summary>PR types and its descriptions</summary>
|
||||
<summary>Help</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.
|
||||
|
||||
- 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
|
||||
</details>
|
||||
|
||||
**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
|
||||
|
||||
<details>
|
||||
<summary>Note</summary>
|
||||
<summary>Help</summary>
|
||||
|
||||
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
|
||||
</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. -->
|
||||
|
||||
|
||||
|
||||
## Equivalent PRs
|
||||
<details>
|
||||
<summary>Help</summary>
|
||||
|
||||
- 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.
|
||||
</details>
|
||||
|
||||
<!-- Link any equivalent PRs using a prefix '#' followed by PR number -->
|
||||
|
||||
|
||||
|
||||
## 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 '#')
|
||||
-->
|
||||
<details>
|
||||
<summary>Help</summary>
|
||||
|
||||
- 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.
|
||||
</details>
|
||||
|
||||
<!-- Link any referenced PRs using a prefix '#' followed by PR number -->
|
||||
|
||||
|
||||
|
||||
## Release notes
|
||||
|
||||
<details>
|
||||
<summary>Note</summary>
|
||||
<summary>Help</summary>
|
||||
|
||||
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
|
||||
</details>
|
||||
|
||||
<!-- Selected: '[x]', Unselected: '[ ]' or Click when not in editing mode -->
|
||||
- [ ] No Release Note
|
||||
<!-- Describe the user-visible change introduced by this PR below. -->
|
||||
<!-- Choose either 'No Release Note' or describe the user-visible change introduced by this PR below. -->
|
||||
|
||||
|
||||
|
||||
## Checklist:
|
||||
|
||||
<details>
|
||||
<summary>Before submitting</summary>
|
||||
|
||||
- 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
|
||||
</details>
|
||||
|
||||
|
||||
|
||||
## PR Automation & Validation
|
||||
<details>
|
||||
<summary>Additional Information</summary>
|
||||
|
||||
List of automation and validations can be found at https://psich.atlassian.net/wiki/x/AQB2P
|
||||
|
||||
</details>
|
||||
Reference in new issue
Block a user