Skip to content

Commit 9287266

Browse files
New github report templates (#908)
* New github report templates Edited the bug report and feature request github templates to guide the users in creating better reports. Also removed the duplicate report issue template and the superfluous custom report template * fixed typos
1 parent 2cd9612 commit 9287266

File tree

4 files changed

+46
-87
lines changed

4 files changed

+46
-87
lines changed
Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,35 @@
11
---
2-
name: Bug report
3-
about: Create a report to help us improve
4-
title: ''
5-
labels: ''
2+
name: Bug Report
3+
about: Create a report to help us improve the project
4+
title: "[BUG] - [Short description of the issue]"
5+
labels: bug
66
assignees: ''
7-
87
---
98

10-
### Excel Type
11-
12-
- [ ] XLSX
13-
- [ ] XLSM
14-
- [ ] CSV
15-
- [ ] OTHER
16-
17-
### Upload Excel File
18-
19-
Please attach your issue file by dragging or droppng, selecting or pasting them.
20-
21-
e.g : [https://github.com/shps951023/MiniExcel/files/6538107/demo.xlsx](https://github.com/shps951023/MiniExcel/files/6538107/demo.xlsx)
9+
## Description
10+
A clear and concise description of what the bug is about.
11+
Include a minimum reproducible sample of the code and, if applicable, the exception message and its stack trace.
12+
Please write in English for the sake of our international contributors!
2213

14+
## Expected Behavior
15+
A brief description of what you expected to happen.
2316

17+
## Actual Behavior
18+
A brief description of what actually happened.
2419

25-
### MiniExcel Version
20+
## Workarounds
21+
Please share what adjacent solutions you've found for the issue, if any.
2622

23+
## Environment (please fill the following information):
24+
- MiniExcel Version: [e.g. 1.42.0, 1.41.4, 2.0.0-preview.2]
25+
- .NET Version: [e.g. net10.0, net481]
26+
- OS: [e.g. Windows, macOS, Linux]
2727

28+
## Files and/or Screenshots
29+
If applicable, please upload:
30+
- The document you're trying to query, or a mock if not available
31+
- The malformed result of the document you're tying to generate
32+
- The template document you're trying to fill
2833

29-
### Description
34+
## Additional Context
35+
Include here any extra info, diagrams, or links.

.github/ISSUE_TEMPLATE/custom.md

Lines changed: 0 additions & 29 deletions
This file was deleted.
Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,31 @@
11
---
2-
name: Feature request
3-
about: Suggest an idea for this project
4-
title: ''
5-
labels: ''
6-
assignees: ''
7-
2+
name: Feature Request
3+
about: Suggest an idea or improvement for this project
4+
title: "[Feature] - [Title of the request]"
5+
labels: enhancement
6+
assignees: ""
87
---
98

10-
### Excel Type
9+
## Feature Summary
10+
A clear and concise description of what the feature is about.
11+
Please write in English for the sake of our international contributors!
12+
13+
## Document Formats
14+
What document formats will benefit from this new functionality?
1115

1216
- [ ] XLSX
13-
- [ ] XLSM
1417
- [ ] CSV
15-
- [ ] OTHER
16-
17-
### Upload Excel File
18-
19-
Please attach your issue file by dragging or droppng, selecting or pasting them.
20-
21-
e.g : [https://github.com/shps951023/MiniExcel/files/6538107/demo.xlsx](https://github.com/shps951023/MiniExcel/files/6538107/demo.xlsx)
22-
23-
18+
- [ ] XLSM
19+
- [ ] Other
2420

25-
### MiniExcel Version
21+
## Motivation
22+
How does the need for this feature arise? What problem does it solve?
2623

24+
## Proposed Solution
25+
Describe how you envision this feature working. Be as detailed as you can.
2726

27+
## Alternatives Considered
28+
Have you considered any alternative solutions or workarounds?
2829

29-
### Description
30+
## Additional Context
31+
Include any extra info, screenshots, diagrams, or links.

.github/ISSUE_TEMPLATE/report_issue.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)