Skip to content

Commit

Permalink
Merge pull request #9671 from satijalab/issue-template-revamp
Browse files Browse the repository at this point in the history
Issue Template revamp
  • Loading branch information
dcollins15 authored Feb 6, 2025
2 parents 6885cfd + b88e134 commit 1549c8d
Show file tree
Hide file tree
Showing 8 changed files with 110 additions and 52 deletions.
12 changes: 0 additions & 12 deletions .github/ISSUE_TEMPLATE/analysis-question.md

This file was deleted.

53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Bug Report
description: Create a report to help improve Seurat
title: "BUG: <insert-descriptive-title>"
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
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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
10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/documentation.md

This file was deleted.

20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Documentation
description: Create a report to help improve Seurat's documentation
title: "Documentation: <insert-descriptive-title>"
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).
10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/feature-request.md

This file was deleted.

31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Feature Request
description: Suggest new feature for Seurat
title: "Feature Request: <insert-descriptive-title>"
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

0 comments on commit 1549c8d

Please sign in to comment.