From e1dd27b9b061626ee0cddc6e6f1a0fc67b6512cf Mon Sep 17 00:00:00 2001 From: Chandrakala Subramanyam Date: Wed, 22 Nov 2023 13:29:54 +0530 Subject: [PATCH 1/3] Included PR and issue templates Signed-off-by: Chandrakala Subramanyam --- .github/issue_template.md | 24 ++++++++++++++++++++++ .github/pull_request_template.md | 35 ++++++++++++++++++++++++++++++++ 2 files changed, 59 insertions(+) create mode 100644 .github/issue_template.md create mode 100644 .github/pull_request_template.md diff --git a/.github/issue_template.md b/.github/issue_template.md new file mode 100644 index 000000000..b402c214b --- /dev/null +++ b/.github/issue_template.md @@ -0,0 +1,24 @@ +## What is being tested? + +Describe the scenario being tested + +## What is the current behavior? + +Provide details of the current behaviour + +### Please provide the steps to reproduce + +Add steps to reproduce the issue here + +### Details of the test environment: + +Kruize release: +Kubernetes cluster: + +## What is the expected behavior? + +Describe the expected behavior + +## Additional information: + +Add any relevant links, screenshots diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..73440d6cc --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,35 @@ +## Description + +Please describe the issue or feature and the summary of changes made to fix this. + +Fixes # (issue) + +### Type of change + +- [ ] Bug fix +- [ ] New feature +- [ ] Docs update +- [ ] Breaking change (What changes might users need to make in their application due to this PR?) +- [ ] Requires DB changes + +## How has this been tested? + +Please describe the tests that were run to verify your changes and steps to reproduce. Please specify any test configuration required. + +- [ ] New Test X +- [ ] Functional testsuite + +**Test Configuration** +* Kubernetes clusters tested on: + +## Checklist :dart: + +- [ ] Followed coding guidelines +- [ ] Comments added +- [ ] Dependent changes merged +- [ ] Documentation updated +- [ ] Tests added or updated + +## Additional information + +Include any additional information such as links, test results, screenshots here From 4fd6c868012b996bc5895b2bb73c95b3172195d2 Mon Sep 17 00:00:00 2001 From: Chandrakala Subramanyam Date: Thu, 27 Jun 2024 22:16:11 +0530 Subject: [PATCH 2/3] Addressed review comments to include latest issue template Signed-off-by: Chandrakala Subramanyam --- .github/ISSUE_TEMPLATE/bug_report.md | 26 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 6 ++++++ .github/ISSUE_TEMPLATE/feature_request.md | 24 +++++++++++++++++++++ .github/issue_template.md | 24 --------------------- 4 files changed, 56 insertions(+), 24 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/issue_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..b3d23b195 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,26 @@ +--- +name: Bug report +about: Create a report to help us improve +title: " " +labels: bug +assignees: '' +--- + +**Describe the bug** +A clear and concise description of the bug + +**How to reproduce it** + +**Expected behavior** +A clear and concise description of the expected behavior + +**Relevant logs** +Attach any relevant logs to help debug the issue + +**Environment:** +- Kubernetes Cluster [e.g. minikube, openshift, kind] +- Version +- OS + +**Additional context** +Add any other context about the problem here, any links or screenshots diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..a46599d00 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,6 @@ +blank_issues_enabled: false +contact_links: + - name: "Questions via Kruize Community slack - #autotune" + url: https://kruizeworkspace.slack.com/archives/C01R7HV4LPN + about: "Join us for questions, answers or Kruize related chat." + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..7c728acc1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,24 @@ +--- +name: "Feature Request" +about: Suggest an idea to improve Kruize +title: '' +labels: "enhancement" +assignees: '' + +--- + +### Describe the feature + +Provide a clear and concise description of what the feature is about + +### Examples or references + +Add any examples or references to understand it better + +### Suggest a solution + +Any suggestions on how to solve this + +### Additional Context + +Any additional context about the feature diff --git a/.github/issue_template.md b/.github/issue_template.md deleted file mode 100644 index b402c214b..000000000 --- a/.github/issue_template.md +++ /dev/null @@ -1,24 +0,0 @@ -## What is being tested? - -Describe the scenario being tested - -## What is the current behavior? - -Provide details of the current behaviour - -### Please provide the steps to reproduce - -Add steps to reproduce the issue here - -### Details of the test environment: - -Kruize release: -Kubernetes cluster: - -## What is the expected behavior? - -Describe the expected behavior - -## Additional information: - -Add any relevant links, screenshots From 6c33ac50300c120ece8648a472d6d7ee47298a2c Mon Sep 17 00:00:00 2001 From: Chandrakala Subramanyam Date: Thu, 27 Jun 2024 22:20:09 +0530 Subject: [PATCH 3/3] Updated description in bug report Signed-off-by: Chandrakala Subramanyam --- .github/ISSUE_TEMPLATE/bug_report.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index b3d23b195..74e2ace1a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -10,6 +10,7 @@ assignees: '' A clear and concise description of the bug **How to reproduce it** +Please provide steps to reproduce the issue **Expected behavior** A clear and concise description of the expected behavior