Skip to content

Commit f194726

Browse files
IanHoangIan Hoang
and
Ian Hoang
authored
Update issue templates for better user experience and incorporate OSB logo into README (opensearch-project#534)
Signed-off-by: Ian Hoang <hoangia@amazon.com> Co-authored-by: Ian Hoang <hoangia@amazon.com>
1 parent 3d9ca6e commit f194726

8 files changed

+154
-92
lines changed

.github/ISSUE_TEMPLATE/bug_template.md

-27
This file was deleted.
+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
name: Bug Report 🐛
3+
description: File a bug report
4+
title: '[Bug]: '
5+
labels: [bug, untriaged]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this bug report!
11+
- type: textarea
12+
id: what-happened
13+
attributes:
14+
label: Describe the bug
15+
description: A clear and concise description of what the bug is.
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: to-Reproduce
20+
attributes:
21+
label: To reproduce
22+
description: Steps to reproduce the behavior
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: Expected-behaviour
27+
attributes:
28+
label: Expected behavior
29+
description: A clear and concise description of what you expected to happen.
30+
- type: textarea
31+
id: screenshots
32+
attributes:
33+
label: Screenshots
34+
description: Attach the screenshots associated with this issue
35+
value: If applicable, add screenshots to help explain your problem.
36+
- type: textarea
37+
id: Host-Environment
38+
attributes:
39+
label: Host / Environment
40+
description: Hosts / Environment information to reproduce this bug
41+
- type: textarea
42+
id: additional-context
43+
attributes:
44+
label: Additional context
45+
description: Add any other context about the problem here.
46+
- type: textarea
47+
id: logs
48+
attributes:
49+
label: Relevant log output
50+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so please don't insert Markdown backticks.
51+
render: shell

.github/ISSUE_TEMPLATE/feature_template.md

-23
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Feature request 🎆
3+
description: Suggest a new feature or an idea you have for this project
4+
labels: [enhancement, untriaged]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to submit a feature request!
10+
- type: textarea
11+
id: feature
12+
attributes:
13+
label: Is your feature request related to a problem? Please describe
14+
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: solution
19+
attributes:
20+
label: Describe the solution you'd like
21+
description: A clear and concise description of what you want to happen.
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: alternatives
26+
attributes:
27+
label: Describe alternatives you've considered
28+
description: A clear and concise description of any alternative solutions or features you've considered.
29+
- type: textarea
30+
id: additional-context
31+
attributes:
32+
label: Additional context
33+
description: Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/proposal_template.md

-40
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
name: Proposal
3+
description: Suggest an idea for a specific feature you wish to propose to the community for comment
4+
title: '[RFC/PROPOSAL]: '
5+
labels: [RFC, untriaged]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this RFC / Proposal!
11+
- type: textarea
12+
id: what-are-you-proposing
13+
attributes:
14+
label: What are you proposing?
15+
description: In a few sentences, describe the feature and its core capabilities.
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: what-users-have-asked-for-this-feature
20+
attributes:
21+
label: What users have asked for this feature?
22+
description: Highlight any research, proposals, requests or anecdotes that signal this is the right thing to build. Include links to GitHub Issues, Forums, Stack Overflow, X (Twitter), Etc
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: what-problems-are-you-trying-to-solve
27+
attributes:
28+
label: What problems are you trying to solve?
29+
description: Summarize use cases, user problems, and needs you are trying to solve. Describe the most important user needs, pain points and jobs as expressed by the user asks above.
30+
- type: textarea
31+
id: what-will-developer-experience-be-like
32+
attributes:
33+
label: What will the developer experience be like?
34+
description: Does this have a REST API? If so, please describe the API and any impact it may have to existing APIs. In a brief summary (not a spec), highlight what new REST APIs or changes to REST APIs are planned. as well as any other API, CLI or Configuration changes that are planned as part of this feature.
35+
- type: textarea
36+
id: are-there-any-security-coniderations
37+
attributes:
38+
label: Are there any security considerations?
39+
description: Describe if the feature has any security considerations or impact. What is the security model of the new APIs? Features should be integrated into the OpenSearch security suite and so if they are not, we should highlight the reasons here
40+
- type: textarea
41+
id: are-there-any-breaking-changes
42+
attributes:
43+
label: Are there any breaking changes?
44+
description: If this feature will require breaking changes to any APIs, ouline what those are and why they are needed. What is the path to minimizing impact? (example, add new API and deprecate the old one)
45+
- type: textarea
46+
id: what-will-the-user-experience-be-like
47+
attributes:
48+
label: What will the user experience be like?
49+
description: Describe the feature requirements and/or user stories. You may include low-fidelity sketches, wireframes, APIs stubs, or other examples of how a user would use the feature via CLI. Using a bulleted list or simple diagrams to outline features is okay. If this is net new functionality, call this out as well.
50+
- type: textarea
51+
id: are-there-breaking-changes-to-user-experience
52+
attributes:
53+
label: Are there breaking changes to user experience?
54+
description: Will this change the existing user experience? Will this be a breaking change from a user flow or user experience perspective?
55+
- type: textarea
56+
id: why-should-it-be-built
57+
attributes:
58+
label: Why should it be built? Any reason not to?
59+
description: Describe the value that this feature will bring to the OpenSearch community, as well as what impact it has if it isn't built, or new risks if it is. Highlight opportunities for additional research.
60+
- type: textarea
61+
id: what-will-it-take-to-execute
62+
attributes:
63+
label: What will it take to execute?
64+
description: Describe what it will take to build this feature. Are there any assumptions you may be making that could limit scope or add limitations? Are there performance, cost, or technical constraints that may impact the user experience? Does this feature depend on other feature work? What additional risks are there?
65+
- type: textarea
66+
id: any-remaining-open-questions
67+
attributes:
68+
label: Any remaining open questions?
69+
description: What are the known enhancements to this feature? Are there any enhancements that may be out of scope but which we will want to track long term? List any other open questions that may need to be answered before proceeding with an implementation.

README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
OpenSearch Benchmark
2-
====================
1+
<img src="https://raw.githubusercontent.com/opensearch-project/opensearch-benchmark/blob/main/opensearch_benchmark.png" height="64px" alt="OpenSearch Benchmark">
32

43
OpenSearch Benchmark is the macrobenchmarking framework for OpenSearch.
54

opensearch_benchmark.png

16.5 KB
Loading

0 commit comments

Comments
 (0)