From b4418e73b975e26d2d151aa4ad536a48be9819c4 Mon Sep 17 00:00:00 2001 From: Vianney Veremme Date: Mon, 14 Apr 2025 10:00:06 -0400 Subject: [PATCH] Add issue templates for bug reports and feature requests; enhance contribution guidelines. --- .github/ISSUE_TEMPLATE/bug_report.md | 46 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 23 ++++++++++++ 2 files changed, 69 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..a750db7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,46 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' +--- + +## Describe the bug + +- A clear and concise description of what the bug is. + +## To Reproduce + +- Steps to reproduce the behavior: + +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +## Expected behavior + +- A clear and concise description of what you expected to + happen. + +## Screenshots + +- If applicable, add screenshots to help explain your problem. + +## Desktop (please complete the following information) + +- OS: [e.g. iOS] +- Browser [e.g. chrome, safari] +- Version [e.g. 22] + +## Mobile (please complete the following information) + +- Device: [e.g. iPhone6] +- OS: [e.g. iOS8.1] +- Browser [e.g. stock browser, safari] +- Version [e.g. 22] + +## Additional context + +- Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..a24b863 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' +--- + +## 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 + +- A clear and concise description of what you want to happen. + +## Describe alternatives you've considered + +- A clear and concise description of any alternative solutions or features you've considered. + +## Additional context + +- Add any other context or screenshots about the feature request here.