From baeb59a969037735698c454fb32e28c645789552 Mon Sep 17 00:00:00 2001 From: Francis Pelletier <32526367+f-PLT@users.noreply.github.com> Date: Tue, 14 Jan 2025 18:05:28 -0500 Subject: [PATCH 1/2] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 43 ++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/new-issue.md | 30 +++++++++++++++++++ 2 files changed, 73 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 000000000..c79e753a3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,43 @@ +--- +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 000000000..cc2d23945 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-issue.md @@ -0,0 +1,30 @@ +--- +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. From 607010e50d88e3377ef4d7cc06cae13c6b3966c7 Mon Sep 17 00:00:00 2001 From: f-PLT Date: Fri, 17 Jan 2025 16:39:29 -0500 Subject: [PATCH 2/2] Run IDE autoformatting on issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 24 +++++++++++++++++------- .github/ISSUE_TEMPLATE/new-issue.md | 17 ++++++++++++----- 2 files changed, 29 insertions(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c79e753a3..84fa9ecda 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -8,36 +8,46 @@ 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. + +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 + +- 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.] + +- 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 index cc2d23945..41a1cb499 100644 --- a/.github/ISSUE_TEMPLATE/new-issue.md +++ b/.github/ISSUE_TEMPLATE/new-issue.md @@ -8,23 +8,30 @@ 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. + +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. + +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 + +- 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.