From e7271af699f8512d46feeabd4ea74b5350897d07 Mon Sep 17 00:00:00 2001 From: Michele Bastione Date: Tue, 25 Nov 2025 23:31:31 +0100 Subject: [PATCH 1/2] 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 --- .github/ISSUE_TEMPLATE/bug_report.md | 44 +++++++++++++---------- .github/ISSUE_TEMPLATE/custom.md | 29 --------------- .github/ISSUE_TEMPLATE/feature_request.md | 40 +++++++++++---------- .github/ISSUE_TEMPLATE/report_issue.md | 20 ----------- 4 files changed, 46 insertions(+), 87 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/custom.md delete mode 100644 .github/ISSUE_TEMPLATE/report_issue.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c53f7e4c..72acb3f1 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,29 +1,35 @@ --- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' +name: Bug Report +about: Create a report to help us improve the project +title: "[BUG] - [Short description of the issue]" +labels: bug assignees: '' - --- -### Excel Type - -- [ ] XLSX -- [ ] XLSM -- [ ] CSV -- [ ] OTHER - -### Upload Excel File - -Please attach your issue file by dragging or droppng, selecting or pasting them. - -e.g : [https://github.com/shps951023/MiniExcel/files/6538107/demo.xlsx](https://github.com/shps951023/MiniExcel/files/6538107/demo.xlsx) +## Description +A clear and concise description of what the bug is about. +Include a minimum reproducible sample of the code and, if applicable, the exception message and its stack trace. +Please write in English for the sake of our international contributors! +## Expected Behavior +A brief description of what you expected to happen. +## Actual Behavior +A bried description of what actually happened. -### MiniExcel Version +## Workarounds +Please share what adjacent solutions you've found for the issue, if any. +## Environment (please fill the following information): +- MiniExcel Version: [e.g. 1.42.0, 1.41.4, 2.0.0-preview.2] +- .NET Version: [e.g. net10.0, net481] +- OS: [e.g. Windows, macOS, Linux] +## Files and/or Screenshots +If applicable, please upload: +- The document you're trying to query, or a mock if not available +- The malformed result of the document you're tying to generate +- The template document you're trying to fill -### Description +## Additional Context +Include here any extra info, diagrams, or links. diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md deleted file mode 100644 index 0797283d..00000000 --- a/.github/ISSUE_TEMPLATE/custom.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -name: Custom issue template -about: Describe this issue template's purpose here. -title: '' -labels: '' -assignees: '' - ---- - -### Excel Type - -- [ ] XLSX -- [ ] XLSM -- [ ] CSV -- [ ] OTHER - -### Upload Excel File - -Please attach your issue file by dragging or droppng, selecting or pasting them. - -e.g : [https://github.com/shps951023/MiniExcel/files/6538107/demo.xlsx](https://github.com/shps951023/MiniExcel/files/6538107/demo.xlsx) - - - -### MiniExcel Version - - - -### Description diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 12591e20..0883cf1f 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,29 +1,31 @@ --- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - +name: Feature Request +about: Suggest an idea or improvement for this project +title: "[Feature] - [Title of the request]" +labels: enhancement +assignees: "" --- -### Excel Type +## Feature Summary +A clear and concise description of what the feature is about. +Please write in English for the sake of our international contributors! + +## Document Formats +What document formats will benefit from this new functionality? - [ ] XLSX -- [ ] XLSM - [ ] CSV -- [ ] OTHER - -### Upload Excel File - -Please attach your issue file by dragging or droppng, selecting or pasting them. - -e.g : [https://github.com/shps951023/MiniExcel/files/6538107/demo.xlsx](https://github.com/shps951023/MiniExcel/files/6538107/demo.xlsx) - - +- [ ] XLSM +- [ ] Other -### MiniExcel Version +## Motivation +How does the need for this feature arise? What problem does it solve? +## Proposed Solution +Describe how you envision this feature working. Be as detailed as you can. +## Alternatives Considered +Have you considered any alternative solutions or workarounds? -### Description +## Additional Context +Include any extra info, screenshots, diagrams, or links. diff --git a/.github/ISSUE_TEMPLATE/report_issue.md b/.github/ISSUE_TEMPLATE/report_issue.md deleted file mode 100644 index f719cdc7..00000000 --- a/.github/ISSUE_TEMPLATE/report_issue.md +++ /dev/null @@ -1,20 +0,0 @@ -### Excel Type - -- [ ] XLSX -- [ ] XLSM -- [ ] CSV -- [ ] OTHER - -### Upload Excel File - -Please attach your issue file by dragging or droppng, selecting or pasting them. - -e.g : [demo.xlsx](https://github.com/shps951023/MiniExcel/files/6538107/demo.xlsx) - - - -### MiniExcel Version - - - -### Description \ No newline at end of file From aa6d2a31746fd587baa636fbbe1e0951b73d5b13 Mon Sep 17 00:00:00 2001 From: Michele Bastione Date: Tue, 25 Nov 2025 23:37:41 +0100 Subject: [PATCH 2/2] fixed typos --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 72acb3f1..3b6895d3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -15,7 +15,7 @@ Please write in English for the sake of our international contributors! A brief description of what you expected to happen. ## Actual Behavior -A bried description of what actually happened. +A brief description of what actually happened. ## Workarounds Please share what adjacent solutions you've found for the issue, if any. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 0883cf1f..97088c31 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -16,7 +16,7 @@ What document formats will benefit from this new functionality? - [ ] XLSX - [ ] CSV - [ ] XLSM -- [ ] Other +- [ ] Other ## Motivation How does the need for this feature arise? What problem does it solve?