Skip to content

Commit e54f2ae

Browse files
authored
Create an Issue Template for Better Reporting (#941)
1 parent 4212c78 commit e54f2ae

File tree

3 files changed

+74
-0
lines changed

3 files changed

+74
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "[BUG]"
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Briefly describe the issue and expected behavior. Keep it short but clear to help identify the problem quickly.
12+
-->
13+
## Description
14+
Briefly describe the issue and what you expected to happen.
15+
16+
<!--
17+
Specify the environment details where the issue occurred. Helps to determine if the bug is environment-specific.
18+
-->
19+
## Environment
20+
- **OS:** (e.g., Windows 10, macOS Ventura)
21+
- **Browser/Version:** (if applicable)
22+
- **Version:** (e.g., v1.2.3)
23+
24+
<!--
25+
List the steps to reproduce the issue. This helps others replicate the bug consistently.
26+
-->
27+
## Steps to Reproduce
28+
1. Go to '...'
29+
2. Click on '...'
30+
3. See the issue
31+
32+
<!--
33+
Describe the difference between the expected and actual outcomes. This helps clarify the impact of the bug.
34+
-->
35+
## Expected vs Actual Behavior
36+
- **Expected:** What should happen
37+
- **Actual:** What actually happens
38+
39+
<!--
40+
(Optional) Add supporting materials like screenshots or logs to provide more context about the issue.
41+
-->
42+
## Attachments (Optional)
43+
Add screenshots, logs, or relevant files if needed.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Ask a question
4+
url: https://lists.apache.org/list.html?dev@baremaps.apache.org
5+
about: Please ask and answer questions here
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "[FEATURE]"
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Clearly explain the feature you’re requesting. Focus on what it does and why it’s needed.
12+
-->
13+
## Description
14+
Clearly explain the feature you’d like to see.
15+
16+
<!--
17+
Describe how and where this feature will be used. Provides context for its practical application.
18+
-->
19+
## Use Case
20+
Why is this feature needed? How will it be used?
21+
22+
<!--
23+
Explain the positive outcomes this feature will bring. Helps prioritize based on impact.
24+
-->
25+
## Expected Impact
26+
What benefits will this feature bring?

0 commit comments

Comments
 (0)