From a450d5eb493fc3172fa89977a2fc2c0ddb72ab4e Mon Sep 17 00:00:00 2001 From: Sergejs Luhmirins Date: Thu, 6 Mar 2025 10:03:23 +0200 Subject: [PATCH] SM-673 Add basic PR templates --- .github/PULL_REQUEST_TEMPLATE/bugfix_pr.md | 29 +++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE/feature_pr.md | 25 ++++++++++++++++++ 2 files changed, 54 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/bugfix_pr.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/feature_pr.md diff --git a/.github/PULL_REQUEST_TEMPLATE/bugfix_pr.md b/.github/PULL_REQUEST_TEMPLATE/bugfix_pr.md new file mode 100644 index 0000000000..630b2a2ec4 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/bugfix_pr.md @@ -0,0 +1,29 @@ +--- +name: Bugfix PR +about: Resolving issues in existing SID features + +--- + +[JIRA ticket]() +Will be released in: **version** +First known affected version: **version** + +### Root cause analysis + +* Describe how it was found and what caused the issue +* Include images to better illustrate the issue + +### Notable changes + +* Describe the changes in the PR and how they fix the root cause +* Include images or video to better illustrate the fix + +### Testing guidance + +* Describe how the reviewers can verify that issue is fixed + +### Additional work checklist + +* [ ] Effect on other features and security has been considered +* [ ] Test cases in Testiny are up to date (or ticket created) +* [ ] Other teams notified about the fix (if applicable) diff --git a/.github/PULL_REQUEST_TEMPLATE/feature_pr.md b/.github/PULL_REQUEST_TEMPLATE/feature_pr.md new file mode 100644 index 0000000000..102014ee5f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/feature_pr.md @@ -0,0 +1,25 @@ +--- +name: Feature PR +about: Additions and improvements to SID + +--- + +[JIRA ticket]() +Will be released in: **version** + +### Notable changes + +* Describe the main changes in the PR with the reasons why they are required +* Include images to better illustrate the changes + +### Testing guidance (optional) + +* Describe how the reviewers can try the new features out + +### Additional work checklist + +* [ ] Effect on other features and security has been considered +* [ ] Design document marked as "In development" (if applicable) +* [ ] External (Gitbook) and internal (Confluence) Documentation is up to date (or ticket created) +* [ ] Test cases in Testiny are up to date (or ticket created) +* [ ] Other teams notified about the changes (if applicable)