Skip to content

Commit

Permalink
Add issue templates and fix readme typos (opensearch-project#3)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
peterzhuamazon authored Aug 27, 2021
1 parent caa9396 commit 246bd3d
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 2 deletions.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_template.md
Original file line number Diff line number Diff line change
@@ -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.

20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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.

4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<img src="https://opensearch.org/assets/brand/SVG/Logo/opensearch_logo_default.svg" height="64px"/>

- [Charts](#charts)
- [OpenSearch Project Helm-Charts](#helm-charts)
- [Contributing](#contributing)
- [Getting Help](#getting-help)
- [Code of Conduct](#code-of-conduct)
- [Security](#security)
- [License](#license)
- [Copyright](#copyright)

## OpenSearch Project Charts
## OpenSearch Project Helm-Charts

A community repository for Helm Charts of OpenSearch Project.

Expand Down

0 comments on commit 246bd3d

Please sign in to comment.