Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup bug, feature and proposal templates. #18

Merged
merged 2 commits into from
Jul 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 13 additions & 15 deletions ISSUE_TEMPLATE/BUG_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,31 @@
---
name: 🐛 Bug report
about: Create a report to help us improve
title: "[BUG]"
labels: 'bug, untriaged, beta'
title: '[BUG]'
labels: 'bug, untriaged'
assignees: ''
---

**Describe the bug**
A clear and concise description of what the bug is.
**What is the bug?**
A clear and concise description of the bug.

**To Reproduce**
**How can one reproduce the bug?**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
**What is the expected behavior?**
A clear and concise description of what you expected to happen.

**Plugins**
Please list all plugins currently enabled.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Host/Environment (please complete the following information):**
**What is your host/environment?**
- OS: [e.g. iOS]
- Version [e.g. 22]
- Plugins

**Do you have any screenshots?**
If applicable, add screenshots to help explain your problem.

**Additional context**
Add any other context about the problem here.
**Do you have any additional context?**
Add any other context about the problem.
15 changes: 7 additions & 8 deletions ISSUE_TEMPLATE/FEATURE_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
---
name: 🎆 Feature request
about: Suggest an idea for this project
title: ''
about: Request a feature in this project
title: '[FEATURE]'
labels: enhancement
assignees: ''
---
**Is your feature request related to a problem?**
A clear and concise description of what the problem is, e.g. _I'm always frustrated when [...]_

**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**
**What solution would you like?**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
**What alternatives have you considered?**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
**Do you have any additional context?**
Add any other context or screenshots about the feature request here.
44 changes: 12 additions & 32 deletions ISSUE_TEMPLATE/PROPOSAL_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,21 @@
---
name: Proposal Template
name: 💭 Proposal
about: Suggest an idea for a specific feature you wish to propose to the community for comment
title: ''
title: '[PROPOSAL]'
labels: proposal
assignees: ''
---
## What kind of business use case are you trying to solve? What are your requirements?
A clear and concise description of the business problem, e.g. _My customers are asking for [...]_

<!--
Welcome to the OpenSearch project! 👋🎉
**What is the problem? What is preventing you from meeting the requirements?**
Describe what impact this problem has for lack of a solution.

**What are you proposing? What do you suggest we do to solve the problem or improve the existing situation?**
Describe your proposed solution. It's OK if you don't have one.

- Please be respectful and considerate of others when commenting on issues.
- Search for existing issues before creating duplicate proposals
- Try to provide as much detail as possible
- Please delete the comments before posting
- When opening a feature request you should expect to contribute a solution or part of this to make it a reality.
- Think of this like a requirements doc a product manager may fill out but with less rigor typically
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is some content from the COC, and some that's general across all issues, so I removed it to avoid saying different things in different places. The comments are also not something GitHub shows in any interesting ways, so I think writers of issues should overwrite the text just like in the bug and feature templates alongside proposal.

Now, if we do think we should have a comment section like this, we can add it in all templates. In this PR I am voting to remove it.

**What are your assumptions or prerequisites?**
Describe any assumptions you may be making that would limit the scope of this proposal.

- If you only have a question, you may get a faster response by asking in the forum.
https://discuss.opendistrocommunity.dev/c/forking-elasticsearch-kibana/50
(but please don't double post)
-->

## Requirement - what kind of business use case are you trying to solve?
<!-- What is the business case or user reason for you wanting to build this feature or capability? -->
<!-- required section -->

## Problem - what blocks you from solving the requirement?
<!-- What is the impact of you not having this feature, what blocks you from solving a specific problem? -->
<!-- required section -->

## Proposal - what do you suggest to solve the problem or improve the existing situation?
<!-- It's okay if you don't have one here, but if there is a workaround or other way this could be solved please suggest it here-->

## Assumptions - are there certain things you assume the user is doing before this?
<!-- With this proposal are you making some assumptions about the user or the specific situation? -->
<!-- It's ok if you don't have one. -->

## Any open questions to address
<!-- Add any other questions you would like the community to address? -->
**What are remaining open questions?**
List questions that may need to be answered before proceeding with an implementation.