diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 5f27ad600..4756b0a43 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,48 +1,94 @@ + + ## PR type -**Select exactly one:** +
+PR types and its descriptions +- 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. + +
+ +**Select exactly one:** + - [ ] Feature - [ ] Bug Fix - [ ] Infrastructure ## Breaking API -- [ ] This is a Breaking API change (Feature or Bug Fix). +
+Note + +Not affecting Infrastructure PRs. + +Breaking API includes: +- API breaks +- Not server-firmware API break +- Major file version change (not just aare affected) +
+ + +- [ ] This is a Breaking API change. ## Description + - - -## Equivalent PRs - - ## Release notes - +Not affecting Infrastructure PRs. - +- [ ] No Release Note + + + + +## 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. ---> \ No newline at end of file +- 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 \ No newline at end of file