From c0c47baa336b5ae36e0bfc53f49cd27a1f54d0ef Mon Sep 17 00:00:00 2001 From: Qingchuan Hao Date: Wed, 10 Jun 2020 17:39:23 +0800 Subject: [PATCH 1/4] Simply issue template --- .github/ISSUE_TEMPLATE.md | 50 +++++++-------------------------------- 1 file changed, 8 insertions(+), 42 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index f3b52c295b..b11bac6355 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,33 +1,3 @@ - - -**Is this a request for help?**: - ---- - -**Is this an ISSUE or FEATURE REQUEST?** (choose one): - ---- - -**Which release version?**: - ---- - -**Which component (CNI/IPAM/CNM/CNS)**: - ---- - -**Which Operating System (Linux/Windows)**: - ---- - -**For Linux: Include Distro and kernel version using "uname -a"** - ---- - -**For windows: provide output of "$(Get-ItemProperty -Path "C:\windows\system32\hal.dll").VersionInfo.FileVersion"** - ---- - -**Which Orchestrator and version (e.g. Kubernetes, Docker)** - ---- +**Is this an ISSUE or FEATURE REQUEST?**: **What happened**: ---- - **What you expected to happen**: ---- - -**How to reproduce it** (as minimally and precisely as possible): - ---- +**How to reproduce it**: -**Anything else we need to know**: +**Anything else we need to know?**: ---- +**Environment**: +- orchestrator and version (e.g. Kubernetes, Docker): +- component and version (CNI/IPAM/CNM/CNS): +- operation system (Linux/Windows): +- Kernel (e.g. `uanme -a` for Linux or `$(Get-ItemProperty -Path "C:\windows\system32\hal.dll").VersionInfo.FileVersion` for Windows): \ No newline at end of file From c766a575000496c28e6c9fa68fc7f43dfec45d45 Mon Sep 17 00:00:00 2001 From: Qingchuan Hao Date: Wed, 17 Jun 2020 09:34:30 +0800 Subject: [PATCH 2/4] Use issue template builder --- .github/ISSUE_TEMPLATE.md | 29 ----------------------- .github/ISSUE_TEMPLATE/bug_report.md | 22 +++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 17 +++++++++++++ 3 files changed, 39 insertions(+), 29 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index b11bac6355..0000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,29 +0,0 @@ - - -**Is this an ISSUE or FEATURE REQUEST?**: - -**What happened**: - -**What you expected to happen**: - -**How to reproduce it**: - -**Anything else we need to know?**: - -**Environment**: -- orchestrator and version (e.g. Kubernetes, Docker): -- component and version (CNI/IPAM/CNM/CNS): -- operation system (Linux/Windows): -- Kernel (e.g. `uanme -a` for Linux or `$(Get-ItemProperty -Path "C:\windows\system32\hal.dll").VersionInfo.FileVersion` for Windows): \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..5d7cdd6a9b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,22 @@ +--- +name: 'Bug Report' +about: Create a report to help us improve + +--- + + +**What happened**: + +**What you expected to happen**: + +**How to reproduce it**: + +**Anything else we need to know?**: +[Miscellaneous information that will assist in solving the issue.] + + +**Environment**: +- orchestrator and version (e.g. Kubernetes, Docker): +- component and version (CNI/IPAM/CNM/CNS): +- operation system (Linux/Windows): +- Kernel (e.g. `uanme -a` for Linux or `$(Get-ItemProperty -Path "C:\windows\system32\hal.dll").VersionInfo.FileVersion` for Windows): diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..1d7a15e2af --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: 'Feature request' +about: Suggest an idea for this project. + +--- + +**Describe in detail the feature/behavior/change you'd like to see:** + + +**Anything else you would like to add:** +[Miscellaneous information that will assist in solving the issue.] + + +**Environment:** +- orchestrator and version (e.g. Kubernetes, Docker): +- component and version (CNI/IPAM/CNM/CNS): +- operation system (Linux/Windows): From 069c5965592579adee78b7ede958dddc0186e0a1 Mon Sep 17 00:00:00 2001 From: Qingchuan Hao Date: Wed, 17 Jun 2020 09:38:20 +0800 Subject: [PATCH 3/4] Small improvements --- .github/ISSUE_TEMPLATE/bug_report.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 5d7cdd6a9b..c2048fc9f2 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,22 +1,25 @@ --- name: 'Bug Report' -about: Create a report to help us improve +about: Create a report to help us improve --- +**What happened:** -**What happened**: -**What you expected to happen**: +**What you expected to happen:** -**How to reproduce it**: -**Anything else we need to know?**: +**How to reproduce it:** + + +**Anything else we need to know?:** [Miscellaneous information that will assist in solving the issue.] -**Environment**: +**Environment:** - orchestrator and version (e.g. Kubernetes, Docker): - component and version (CNI/IPAM/CNM/CNS): - operation system (Linux/Windows): - Kernel (e.g. `uanme -a` for Linux or `$(Get-ItemProperty -Path "C:\windows\system32\hal.dll").VersionInfo.FileVersion` for Windows): + From 7d6eeae807e6d94842d3f8b3fbef817425414f4b Mon Sep 17 00:00:00 2001 From: Mathew Merrick Date: Thu, 25 Jun 2020 16:32:30 -0700 Subject: [PATCH 4/4] template revision --- .github/ISSUE_TEMPLATE/bug_report.md | 25 ------------ .github/ISSUE_TEMPLATE/cni_bug_report.md | 25 ++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 19 +++++---- .github/ISSUE_TEMPLATE/npm_bug_report.md | 22 +++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 47 ++++++++++++++++------- 5 files changed, 92 insertions(+), 46 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/cni_bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/npm_bug_report.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index c2048fc9f2..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -name: 'Bug Report' -about: Create a report to help us improve - ---- - -**What happened:** - - -**What you expected to happen:** - - -**How to reproduce it:** - - -**Anything else we need to know?:** -[Miscellaneous information that will assist in solving the issue.] - - -**Environment:** -- orchestrator and version (e.g. Kubernetes, Docker): -- component and version (CNI/IPAM/CNM/CNS): -- operation system (Linux/Windows): -- Kernel (e.g. `uanme -a` for Linux or `$(Get-ItemProperty -Path "C:\windows\system32\hal.dll").VersionInfo.FileVersion` for Windows): - diff --git a/.github/ISSUE_TEMPLATE/cni_bug_report.md b/.github/ISSUE_TEMPLATE/cni_bug_report.md new file mode 100644 index 0000000000..9820b6baa0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/cni_bug_report.md @@ -0,0 +1,25 @@ +--- +name: 'CNI Bug Report' +about: Create a report to help us improve +--- + +**What happened:** + + +**What you expected to happen:** + + +**How to reproduce it:** + + +**Orchestrator and Version (e.g. Kubernetes, Docker):** + + +**Operating System (Linux/Windows):** + + +**Kernel (e.g. `uanme -a` for Linux or `$(Get-ItemProperty -Path "C:\windows\system32\hal.dll").VersionInfo.FileVersion` for Windows):** + + +**Anything else we need to know?:** +[Miscellaneous information that will assist in solving the issue.] diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 1d7a15e2af..8b1f29bf37 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,17 +1,20 @@ --- -name: 'Feature request' +name: 'Feature Request' about: Suggest an idea for this project. --- +**Component (Azure NPM or Azure CNI):** -**Describe in detail the feature/behavior/change you'd like to see:** +**Describe in detail the feature/behavior/change you'd like to see:** + + +**Orchestrator(e.g. Kubernetes, Docker):** -**Anything else you would like to add:** -[Miscellaneous information that will assist in solving the issue.] +**Operating System (Linux/Windows):** + + +**Anything else you would like to add:** +[Miscellaneous information that will assist in solving the issue.] -**Environment:** -- orchestrator and version (e.g. Kubernetes, Docker): -- component and version (CNI/IPAM/CNM/CNS): -- operation system (Linux/Windows): diff --git a/.github/ISSUE_TEMPLATE/npm_bug_report.md b/.github/ISSUE_TEMPLATE/npm_bug_report.md new file mode 100644 index 0000000000..a79766860d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/npm_bug_report.md @@ -0,0 +1,22 @@ +--- +name: 'NPM Bug Report' +about: Create a report to help us improve +--- + +**What happened:** + + +**What you expected to happen:** + + +**How to reproduce it:** + + +**Kubernetes Version:** + + +**Kernel (e.g. `uname -a`):** + + +**Anything else we need to know?:** +[Miscellaneous information that will assist in solving the issue.] diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9e17cd7ef9..883e1d2186 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,17 +1,38 @@ - + -**What this PR does / why we need it**: +**Reason for Change**: + -**Which issue this PR fixes** *(optional, in `fixes #(, fixes #, ...)` format, will close that issue when PR gets merged)*: fixes # -**Special notes for your reviewer**: +**Issue Fixed**: + -**Release note**: - -```release-note -``` \ No newline at end of file + +**Requirements**: + + + +- [ ] uses [conventional commit messages](https://www.conventionalcommits.org/) + +- [ ] includes documentation +- [ ] adds unit tests + + +**Notes**: