diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index d3295a5b..b8769167 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -35,18 +35,22 @@ body: required: false - type: textarea attributes: - label: Environment + label: Environment (if applicable) description: | - examples: - - **OS**: iOS - - **Browser**: Chrome - - **Python version**: 3.12 - - **Software versions**: [release/branch/commit] + Provide details about your environment to help us reproduce the issue. + + **For all users:** + - **OS**: The operating system you're using (e.g., Windows, macOS, Linux, iOS, Android) + - **Browser**: The browser you're using (e.g., Chrome 124, Safari 17, Firefox 123) + + **For developers contributing to this project** (optional): + - **Python version**: The Python version running the server (e.g., 3.12) + - **Software versions**: The release, branch, or commit you're running (e.g., main, v0.1.0) value: | - - OS: - - Browser: - - Python version: - - Software versions: + - **OS**: + - **Browser**: + - **Python version** (developers only): + - **Software versions** (developers only): render: markdown validations: required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 11fc491e..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -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 [...] - -**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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..237c5e18 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,36 @@ +name: Feature request +description: Suggest an idea for this project +title: '[FEATURE] ' +labels: [enhancement] +body: + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if a similar feature request already exists. + options: + - label: I have searched the existing issues + required: true + - type: textarea + attributes: + label: Is your feature request related to a problem? + description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: false + - type: textarea + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + validations: + required: false + - type: textarea + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false + - type: textarea + attributes: + label: Additional context + description: Add any other context, screenshots, or references about the feature request here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/technical_work.md b/.github/ISSUE_TEMPLATE/technical_work.md deleted file mode 100644 index 5183bf70..00000000 --- a/.github/ISSUE_TEMPLATE/technical_work.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Technical work -about: Technical work that needs to be done to complete work on a (large) user story or feature -title: '' -labels: technical -assignees: '' - ---- - -**Which user story or feature is this technical work related to?** -Put in links to the user story or feature issue here. - -**Describe the aspect of the user stories or features that this technical work is part of** -A clear and concise description of what you plan to do to in this technical work. - -**Additional context** -Add any other context or screenshots about the technical work here. diff --git a/.github/ISSUE_TEMPLATE/technical_work.yml b/.github/ISSUE_TEMPLATE/technical_work.yml new file mode 100644 index 00000000..b97e37d8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/technical_work.yml @@ -0,0 +1,29 @@ +name: Technical work +description: Technical work that needs to be done to complete work on a (large) user story or feature +title: '[TECHNICAL] <title>' +labels: [technical] +body: + - type: textarea + attributes: + label: Related user story or feature + description: Links to the user story or feature issue this technical work is related to. + validations: + required: false + - type: textarea + attributes: + label: Description + description: A clear and concise description of what you plan to do in this technical work and why it's needed. + validations: + required: false + - type: textarea + attributes: + label: Implementation approach (if known) + description: Optional. Describe your planned approach to solving this technical work. + validations: + required: false + - type: textarea + attributes: + label: Additional context + description: Add any other context, diagrams, or references about the technical work here. + validations: + required: false