diff --git a/.github/ISSUE_TEMPLATE/analysis-question.md b/.github/ISSUE_TEMPLATE/analysis-question.md deleted file mode 100644 index c01af6b78..000000000 --- a/.github/ISSUE_TEMPLATE/analysis-question.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -name: "❓Analysis question" -about: Ask a question about the analysis of single-cell data -title: '' -labels: question -assignees: '' - ---- - - - - diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..554d458e8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,53 @@ +name: Bug Report +description: Create a report to help improve Seurat +title: "BUG: " +labels: [bug] + +body: + - type: markdown + attributes: + value: Thank you for taking the time to file a bug report. + - type: markdown + attributes: + value: Before continuing, please check the issue tracker to see if the bug has already been reported. Also check the [changelog](https://github.com/satijalab/seurat/blob/main/NEWS.md) in case the issue has already been fixed in the development version of `Seurat`. + - type: textarea + attributes: + label: Issue Description + description: | + Please provide a clear, concise description of the issue. What did you + expect to happen? What actually happened? Please be as specific as + possible. + validations: + required: true + - type: textarea + attributes: + label: Reproducing Code Example + description: | + Please provide a minimal reproducible example demonstrating the issue + using `pbmc_small` or one of the datasets available via + [`SeuratData`](https://github.com/satijalab/seurat-data). The script + should not depend on any files or variables specific to your local environment. + render: R + validations: + required: true + - type: textarea + attributes: + label: Error Message + description: If any, please paste the *full* error message here. + render: shell + validations: + required: false + - type: textarea + attributes: + label: Additional Comments + description: | + Please include any additional information that maybe relevant. + validations: + required: false + - type: textarea + attributes: + label: Session Info + description: Please paste the output of `sessionInfo()` here. + render: shell + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 5f727b6bc..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: "\U0001F41BBug report" -about: Describe a bug you've seen with a reproducible example -title: '' -labels: bug -assignees: '' - ---- - - - - - - - - - -```r -# insert reproducible example here -``` diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..89e7aa046 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,6 @@ +contact_links: + - name: Analysis Question + url: https://github.com/satijalab/seurat/discussions + about: Ask the community a question about Seurat or single-cell analysis + +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md deleted file mode 100644 index 3990ad5f8..000000000 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: "\U0001F4DADocumentation" -about: An issue related to documentation at https://satijalab.org/seurat/ -title: '' -labels: documentation -assignees: '' - ---- - - diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 000000000..ad3dab45a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,20 @@ +name: Documentation +description: Create a report to help improve Seurat's documentation +title: "Documentation: " +labels: [documentation] + +body: + - type: markdown + attributes: + value: Thank you for taking the time to file a report. + - type: markdown + attributes: + value: Before continuing, please check the issue tracker to see if the problem has already been reported. + - type: textarea + attributes: + label: Issue Description + description: | + Please provide a clear, concise description of the issue. Make sure + to include a reference to the specific page on https://satijalab.org/seurat + and/or the relevant [man/*.Rd](https://github.com/satijalab/seurat/blob/main/man) + file(s). diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index dcdad90ce..000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: "\U0001F680Feature request" -about: Request a new feature -title: '' -labels: enhancement -assignees: '' - ---- - - diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 000000000..6a4886fcf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,31 @@ +name: Feature Request +description: Suggest new feature for Seurat +title: "Feature Request: " +labels: [enhancement] + +body: + - type: textarea + attributes: + label: Motivation + description: | + Please explain your motivation for the request. Why would the feature + be useful? Is your feature request related to a problem? If so, please + describe it. + validations: + required: true + - type: textarea + attributes: + label: Feature Description + description: | + Describe the feature. Please be as specific as possible. + validations: + required: true + - type: textarea + attributes: + label: Alternatives + description: | + Please describe any alternatives you've considered. If applicable, + include workarounds or existing features that partially address your + request. + validations: + required: false