mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2026-10-18 21:45:12 +02:00
* 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
3.4 KiB
3.4 KiB
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
Help
- Feature PR:
- Minor/Major change
- Enhancement
- Compilation/dependency change
- Bug fix to an unreleased feature
- Bug Fix PR:
- Bug fix to released code
- Modifications to released documentation
- Infrastructure PR:
- Workflow/process change
- Helper script
- Internal documentation change
- Bug fix to unreleased infrastructure
Select exactly one:
- Feature
- Bug Fix
- Infrastructure
Breaking API
Help
Not affecting Infrastructure PRs.
Breaking API includes:
- API breaks
- Not server-firmware API break
- 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
Help
Not affecting Infrastructure PRs.
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 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 are in another branch.
PR Automation & Validation
Additional Information
List of automation and validations can be found at https://psich.atlassian.net/wiki/x/AQB2P