diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea7..2f44416 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,38 +1,70 @@ --- name: Bug report about: Create a report to help us improve -title: '' -labels: '' +title: '[Bug]: ' +labels: bug assignees: '' --- -**Describe the bug** -A clear and concise description of what the bug is. +# Bug Report + -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +--- + +## To Reproduce + + +### YAML configuration + +```yaml +# Paste the YAML snippet here +``` + +### CLI command used + +```bash +# Paste the CLI command here +``` + +### Actual output + +```bash +# Paste the output, logs, or error messages here +``` + +### Expected output + + +--- -**Expected behavior** -A clear and concise description of what you expected to happen. +## Environment and Versions -**Screenshots** -If applicable, add screenshots to help explain your problem. +- Operating System: +- Package Version: +- Python Version: +- Package list: + - If using conda, run: `conda list > packages.txt` and paste the contents here. -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] + ``` bash + # Paste packages.txt here + ``` + + - If using venv/pip, run: `pip list > packages.txt` and paste the contents here. + + ``` bash + # Paste packages.txt here + ``` + +--- + +## Screenshots or Logs + + + +--- -**Smartphone (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 -**Additional context** -Add any other context about the problem here. + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..0fa7423 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,22 @@ +blank_issues_enabled: false +issue_templates: + - name: "Bug Report" + description: "Report a bug." + title: "[Bug]: " + labels: ["bug"] + body: "./ISSUE_TEMPLATE/bug_report.md" + - name: "Feature Request" + description: "Propose a new feature or improvement." + title: "[Feature]: " + labels: ["enhancement"] + body: "./ISSUE_TEMPLATE/feature_request.md" + - name: "Documentation" + description: "Suggest updates or additions to the documentation." + title: "[Docs]: " + labels: ["documentation"] + body: "./ISSUE_TEMPLATE/documentation.md" + - name: "General Report" + description: "Provide general feedback or inquiries." + title: "[General]: " + labels: ["general"] + body: "./ISSUE_TEMPLATE/general_report.md" diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md deleted file mode 100644 index 48d5f81..0000000 --- a/.github/ISSUE_TEMPLATE/custom.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Custom issue template -about: Describe this issue template's purpose here. -title: '' -labels: '' -assignees: '' - ---- - - diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..9d0de48 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,19 @@ +--- +name: Documentation +about: Suggest updates or additions to documentation +title: "[Docs]: " +labels: documentation +assignees: '' +--- + +### Documentation Update + + +### Why Is This Needed? + + +### Suggested Changes + + +### Additional Context + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7..1ea16e2 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,20 +1,28 @@ --- name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' +about: Suggest an idea +title: '[Feature]: ' +labels: 'enhancement' 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 [...] +# Feature Request + +## Problem / Motivation + + +## Proposed Solution + -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +## Alternatives Considered +- +- -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +## Expected Impact + +- +- -**Additional context** -Add any other context or screenshots about the feature request here. +## Additional Context + +- diff --git a/.github/ISSUE_TEMPLATE/general_report.md b/.github/ISSUE_TEMPLATE/general_report.md new file mode 100644 index 0000000..611e7c0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/general_report.md @@ -0,0 +1,13 @@ +--- +name: General Report +about: Provide general feedback or inquiries +title: "[General]: " +labels: general +assignees: '' +--- + +### Feedback or Inquiry + + +### Additional Information +