From c3ddfa75c93ae8bca3fe4ffd770ba302e2473a5b Mon Sep 17 00:00:00 2001 From: Satoshi Ikari Date: Wed, 27 Sep 2023 16:05:12 +0200 Subject: [PATCH 1/3] Update PR template --- .github/PULL_REQUEST_TEMPLATE.md | 33 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index eec714260..a219c3fea 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,23 +1,22 @@ -## Overview -Write briefly. +## Related issues +Mention any issues that this pull request is related (e.g., #1). Consider using the `development` field if you want to close the issue automatically when this pull request is merged. -## Issue -- Related issues +## Description +Provide a detailed description of this pull request. -## Details -Write in detail. +## Test results +Provide the test results and a link to the detailed results log. -## Validation results -Link to tests or validation results. +## Impact +Describe the scope of influence of the changes, e.g., `The behavior of feature ** changes.` -## Scope of influence -eg. The behavior of XX will be change. - -## Supplement -Write additional comments if you need. +## Supplementary information +Provide any supplementary information. + From 8baee65a215ea102a615fcf081a962d127818ba3 Mon Sep 17 00:00:00 2001 From: Satoshi Ikari Date: Wed, 27 Sep 2023 16:08:05 +0200 Subject: [PATCH 2/3] Update action item template --- .github/ISSUE_TEMPLATE/action_item.md | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/action_item.md b/.github/ISSUE_TEMPLATE/action_item.md index 7486f31bc..8b173a1f2 100644 --- a/.github/ISSUE_TEMPLATE/action_item.md +++ b/.github/ISSUE_TEMPLATE/action_item.md @@ -1,26 +1,25 @@ --- name: Action Item -about: For Action Item management +about: Create an action item title: '' labels: '' assignees: '' --- -## Overview -Write briefly. - ## Details -Write in detail. +Provide a detailed description of the issue. -## Conditions for close -When xxx is complete. +## Closing conditions +Provide the conditions that must be met for the issue to be closed. -## Supplement -Write additional comments if you need. +## Supplementary information +Provide any supplementary information. ## Note -- If there are related Projects, tie them together. -- Set `priority` label if possible. -- Assignees should be set if possible. -- Write a conclusion when closing the issue. +- Provide a conclusion before closing the issue. + From 36c32d1e9bc5a89ee49c888fc7a07c6629c67759 Mon Sep 17 00:00:00 2001 From: Satoshi Ikari Date: Wed, 27 Sep 2023 16:11:17 +0200 Subject: [PATCH 3/3] Update bug report template --- .github/ISSUE_TEMPLATE/bug_report.md | 35 ++++++++++++++-------------- 1 file changed, 17 insertions(+), 18 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 9f05683b9..91db6c437 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -2,36 +2,35 @@ name: Bug report about: Create a report to help us improve title: '' -labels: '' +labels: ['bug'] assignees: '' --- -## Overview -Write briefly. - ## Details ### Description -What kind of bug? +Describe the bug in detail. ### Conditions of occurrence -The environment in which the bug occurs, the condition, parameters, etc. +Describe the environment, conditions, parameters, etc. under which the bug occurred. -### Additional information -files, link, etc, if any. +### Additional information +Provide any relevant files, links, etc. if available. -## Task +## Tasks - [ ] Fix xxx - [ ] Do yyy -## Scope of influence -eg. All tools are not working. +## Impact +Describe the scope of the bug's influence, e.g., `All tools are not working.` -## Supplement -Write additional comments if you need. +## Supplementary notes +Provide any extra notes if necessary. -## Note -- If there are related Projects, tie them together. -- Set `priority` label if possible. -- Assignees should be set if possible. -- Write a conclusion when closing the issue. +## Notes +- Provide a conclusion before closing the issue. +