From 1b49066ce027bb2ec972eca81b58e56c064849c1 Mon Sep 17 00:00:00 2001 From: rharao <18608184+rharao@users.noreply.github.com> Date: Tue, 24 Dec 2024 05:49:11 -0500 Subject: [PATCH 01/15] Add issue template with helpful hints --- .github/ISSUE_TEMPLATE/guided-bug-report.md | 48 +++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/guided-bug-report.md diff --git a/.github/ISSUE_TEMPLATE/guided-bug-report.md b/.github/ISSUE_TEMPLATE/guided-bug-report.md new file mode 100644 index 000000000..443d0b8c8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/guided-bug-report.md @@ -0,0 +1,48 @@ +--- +name: "\U0001F41BBug report (with guide)" +about: You've noticed a bug in Seurat and want help reporting it +title: '✅ A one-sentence, informative description of the bug you found' +labels: bug +assignees: '' + +--- + + + + +# Problem + + +# Example + + +```r +# Write or paste the example code here +# Be sure to include imports (`library()`) +``` + +## Expected behavior + + +## Actual behavior + + +# Comments + + +## Other issues + + + + +
+ Session info + + + + + +
+ + + From cfab01db5bfa9fc536bde58b3ef3d2ad093cb06f Mon Sep 17 00:00:00 2001 From: rharao <18608184+rharao@users.noreply.github.com> Date: Tue, 24 Dec 2024 06:00:16 -0500 Subject: [PATCH 02/15] Rename issue template for better ordering in chooser --- .../ISSUE_TEMPLATE/{guided-bug-report.md => bug-report-guided.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/ISSUE_TEMPLATE/{guided-bug-report.md => bug-report-guided.md} (100%) diff --git a/.github/ISSUE_TEMPLATE/guided-bug-report.md b/.github/ISSUE_TEMPLATE/bug-report-guided.md similarity index 100% rename from .github/ISSUE_TEMPLATE/guided-bug-report.md rename to .github/ISSUE_TEMPLATE/bug-report-guided.md From 0b4e6da318ba649a44a9bc3618c77e214e577882 Mon Sep 17 00:00:00 2001 From: rharao <18608184+rharao@users.noreply.github.com> Date: Fri, 10 Jan 2025 13:41:07 -0500 Subject: [PATCH 03/15] Encourage users to ask questions on the discussion board --- .github/ISSUE_TEMPLATE/analysis-question.md | 12 ------------ .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 2 files changed, 1 insertion(+), 13 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/analysis-question.md 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.md b/.github/ISSUE_TEMPLATE/bug_report.md index 5f727b6bc..a27a894db 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,7 +7,7 @@ assignees: '' --- - + From cdea55725159494ef25e2ab6e049003352bba70d Mon Sep 17 00:00:00 2001 From: rharao <18608184+rharao@users.noreply.github.com> Date: Fri, 10 Jan 2025 13:42:09 -0500 Subject: [PATCH 04/15] Kebab case for consistency --- .github/ISSUE_TEMPLATE/bug_report.md | 20 -------------------- 1 file changed, 20 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index a27a894db..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 -``` From 2962bd61d33d8bbe6f5271c3e5bcfd308a4312dc Mon Sep 17 00:00:00 2001 From: rharao <18608184+rharao@users.noreply.github.com> Date: Fri, 10 Jan 2025 13:51:21 -0500 Subject: [PATCH 05/15] Kebab case for consistency --- .github/ISSUE_TEMPLATE/bug-report.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 000000000..a27a894db --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,20 @@ +--- +name: "\U0001F41BBug report" +about: Describe a bug you've seen with a reproducible example +title: '' +labels: bug +assignees: '' + +--- + + + + + + + + + +```r +# insert reproducible example here +``` From 4feee1d13d9e3b5c755050e0860235a1669ac78a Mon Sep 17 00:00:00 2001 From: rharao <18608184+rharao@users.noreply.github.com> Date: Thu, 23 Jan 2025 14:55:29 -0500 Subject: [PATCH 06/15] Add ISSUE_TEMPLATE config --- .github/ISSUE_TEMPLATE/config.yml | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..09500e974 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,6 @@ +blank_issues_enabled: false + +contact_links: + - name: Analysis question + url: https://github.com/satijalab/seurat/discussions + about: If you have a question about how to use Seurat, please see our community discussion board. From 35e71fad3090baaad38506f4a9dc9d74399f27f5 Mon Sep 17 00:00:00 2001 From: David Collins Date: Wed, 5 Feb 2025 13:56:33 -0500 Subject: [PATCH 07/15] Drop ISSUE_TEMPLATE/documentation.md --- .github/ISSUE_TEMPLATE/documentation.md | 10 ---------- 1 file changed, 10 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/documentation.md 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: '' - ---- - - From 44891f5eecbbb62c107fb93f6a5124691be76fa0 Mon Sep 17 00:00:00 2001 From: David Collins Date: Wed, 5 Feb 2025 13:56:43 -0500 Subject: [PATCH 08/15] Drop ISSUE_TEMPLATE/feature-request.md --- .github/ISSUE_TEMPLATE/feature-request.md | 10 ---------- 1 file changed, 10 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md 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: '' - ---- - - From 3ed13eef7a1dc98cbed842b129354e1d4231f782 Mon Sep 17 00:00:00 2001 From: David Collins Date: Wed, 5 Feb 2025 13:56:52 -0500 Subject: [PATCH 09/15] Drop ISSUE_TEMPLATE/bug-report.md --- .github/ISSUE_TEMPLATE/bug-report.md | 20 -------------------- 1 file changed, 20 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index a27a894db..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 -``` From 5a09fcd0ee43c45fe167b5e0a181581da0f459b1 Mon Sep 17 00:00:00 2001 From: David Collins Date: Wed, 5 Feb 2025 13:57:03 -0500 Subject: [PATCH 10/15] Drop ISSUE_TEMPLATE/bug-report-guidied.md --- .github/ISSUE_TEMPLATE/bug-report-guided.md | 48 --------------------- 1 file changed, 48 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report-guided.md diff --git a/.github/ISSUE_TEMPLATE/bug-report-guided.md b/.github/ISSUE_TEMPLATE/bug-report-guided.md deleted file mode 100644 index 443d0b8c8..000000000 --- a/.github/ISSUE_TEMPLATE/bug-report-guided.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -name: "\U0001F41BBug report (with guide)" -about: You've noticed a bug in Seurat and want help reporting it -title: '✅ A one-sentence, informative description of the bug you found' -labels: bug -assignees: '' - ---- - - - - -# Problem - - -# Example - - -```r -# Write or paste the example code here -# Be sure to include imports (`library()`) -``` - -## Expected behavior - - -## Actual behavior - - -# Comments - - -## Other issues - - - - -
- Session info - - - - - -
- - - From 39f345e447394f00a9d7c53887d5f4dd67acdd72 Mon Sep 17 00:00:00 2001 From: David Collins Date: Wed, 5 Feb 2025 13:57:53 -0500 Subject: [PATCH 11/15] Enable blank issues --- .github/ISSUE_TEMPLATE/config.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 09500e974..d9c558fb1 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,6 +1,6 @@ -blank_issues_enabled: false - contact_links: - name: Analysis question url: https://github.com/satijalab/seurat/discussions about: If you have a question about how to use Seurat, please see our community discussion board. + +blank_issues_enabled: true From b7687f2a424ea930a8b5ac6b1e30e17133880293 Mon Sep 17 00:00:00 2001 From: David Collins Date: Wed, 5 Feb 2025 14:01:03 -0500 Subject: [PATCH 12/15] Refine analysis-question --- .github/ISSUE_TEMPLATE/config.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index d9c558fb1..89e7aa046 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,6 +1,6 @@ contact_links: - - name: Analysis question + - name: Analysis Question url: https://github.com/satijalab/seurat/discussions - about: If you have a question about how to use Seurat, please see our community discussion board. + about: Ask the community a question about Seurat or single-cell analysis blank_issues_enabled: true From 2c9b46f0982a34c6929d7940e605a85c1c6476dd Mon Sep 17 00:00:00 2001 From: David Collins Date: Wed, 5 Feb 2025 14:04:21 -0500 Subject: [PATCH 13/15] Add ISSUE_TEMPLATE/documentation.yml --- .github/ISSUE_TEMPLATE/documentation.yml | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/documentation.yml 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). From 8bdbae32df8ea9c78136c61c256d5c5702cc7102 Mon Sep 17 00:00:00 2001 From: David Collins Date: Wed, 5 Feb 2025 14:04:32 -0500 Subject: [PATCH 14/15] Add ISSUE_TEMPLATE/feature-request.yml --- .github/ISSUE_TEMPLATE/feature-request.yml | 31 ++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml 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 From b88e1344cabea7d2e09c34e56a7c8f01a7290eb5 Mon Sep 17 00:00:00 2001 From: David Collins Date: Wed, 5 Feb 2025 14:04:49 -0500 Subject: [PATCH 15/15] Add bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 53 +++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml 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