From 246bd3d574a13b67f81604966b8ee6adadd4bfbf Mon Sep 17 00:00:00 2001 From: Peter Zhu Date: Fri, 27 Aug 2021 13:45:33 -0400 Subject: [PATCH] Add issue templates and fix readme typos (#3) * Add issue templates and fix readme typos * Replace component name with chart name * Replace OS/Version to the Helm/Kube versions * Replace OS/Version to the Helm/Kube versions --- .github/ISSUE_TEMPLATE/bug_template.md | 34 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++++++ README.md | 4 +-- 3 files changed, 56 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_template.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_template.md b/.github/ISSUE_TEMPLATE/bug_template.md new file mode 100644 index 00000000..eda2403d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_template.md @@ -0,0 +1,34 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG][Chart Name]" +labels: 'bug, untriaged' +assignees: '' +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Chart Name** +Specify the Chart which is affected? + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Host/Environment (please complete the following information):** + - Helm Version: [e.g. 3.x.x] + - Kubernetes Version: [e.g. 1.16.x] + +**Additional context** +Add any other context about the problem here. + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..f45a99a4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '[Enhancement][Chart Name]' +labels: 'enhancement, untriaged' +assignees: '' +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. + diff --git a/README.md b/README.md index 783ec4c3..052ddb2b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -- [Charts](#charts) +- [OpenSearch Project Helm-Charts](#helm-charts) - [Contributing](#contributing) - [Getting Help](#getting-help) - [Code of Conduct](#code-of-conduct) @@ -8,7 +8,7 @@ - [License](#license) - [Copyright](#copyright) -## OpenSearch Project Charts +## OpenSearch Project Helm-Charts A community repository for Helm Charts of OpenSearch Project.