From 5ae77656b0a0bdaa005c8f537c98e8dd18d5eba2 Mon Sep 17 00:00:00 2001 From: Francis Pelletier <32526367+f-PLT@users.noreply.github.com> Date: Sun, 19 Jan 2025 02:22:51 -0500 Subject: [PATCH] Update issue templates (#669) * Update issue templates * Run IDE autoformatting on issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 53 ++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/new-issue.md | 37 +++++++++++++++++++ 2 files changed, 90 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/new-issue.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..84fa9ecd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,53 @@ +--- +name: Bug report +about: Create a report to describe the bug +title: Fix ... +labels: bug +assignees: '' + +--- + +## Summary + +Brief description of the bug (tl;dr). + +## Detailed Description + +A clear and detailed description of what the bug is, what is affected by it and why it's important to fix it. + +Don't forget to add the other appropriate labels and link the issue to a milestone if applicable. + +## Possible Fix Implementation + +If possible, break down the tasks or steps needed to fix the bug. + +Consider including: + +- Approximate timeline +- Specific files or areas in the codebase concerned +- Possible problems or complications + +## How to Reproduce the Bug + +### Environment + +(please complete the following information) + +- OS and/or device: [e.g. iOS, Windows, Android, etc.] +- Browser [e.g. chrome, safari] +- Version [e.g. Production, Development, etc.] + +### Steps to reproduce the behavior: + +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +## Screenshots + +If applicable, add screenshots to help explain your problem. + +## Additional context + +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/new-issue.md b/.github/ISSUE_TEMPLATE/new-issue.md new file mode 100644 index 00000000..41a1cb49 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-issue.md @@ -0,0 +1,37 @@ +--- +name: New Issue +about: Create a new issue for the project +title: '' +labels: '' +assignees: '' + +--- + +## Summary + +Brief description of the issue (tl;dr). + +## Detailed Description + +Detailed description of the issue and why it is important. You can also talk about proposed ways to solve the issue if +the path forward is not clear. + +Don't forget to add the appropriate labels and link the issue to a milestone if applicable. + +## Implementation Details + +If possible, break down the tasks or steps needed to complete the solution. + +Consider including: + +- Approximate timeline +- Specific files or areas in the codebase concerned +- Possible problems or complications + +## Related Issues + +If applicable, list of related issues + +## Additional Context + +Add any other context or screenshots here.