-
Notifications
You must be signed in to change notification settings - Fork 931
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #9671 from satijalab/issue-template-revamp
Issue Template revamp
- Loading branch information
Showing
8 changed files
with
110 additions
and
52 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |