Skip to content

Commit

Permalink
Merge pull request #448 from microsoft/PreRelease
Browse files Browse the repository at this point in the history
add issue templates for better issue submission experiences.
  • Loading branch information
zhmiao authored Mar 25, 2024
2 parents 2ca2fc5 + 1dea3c2 commit b6ecb7d
Show file tree
Hide file tree
Showing 3 changed files with 146 additions and 0 deletions.
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: Bug Report
# title: " "
description: Problems with Pytorch-Wildlife
labels: [bug]
body:
- type: markdown
attributes:
value: |
Thank you for submitting a Bug Report!
- type: checkboxes
attributes:
label: Search before asking
description: >
Please search the [issues](https://github.com/microsoft/CameraTraps/issues) to see if a similar bug report already exists.
options:
- label: >
I have searched the Pytorch-Wildlife [issues](https://github.com/microsoft/CameraTraps/issues) and found no similar bug report.
required: true
- type: textarea
attributes:
label: Bug
description: Provide console output with error messages and/or screenshots of the bug.
placeholder: |
💡 ProTip! Include as much information as possible (error messages, screenshots, logs, tracebacks, etc.) to receive the most helpful response.
validations:
required: true

- type: textarea
attributes:
label: Environment
description: Please specify the software and hardware you used to produce the bug.
placeholder: |
- PytorchWildlife: 1.0.2.4
- OS: Ubuntu 18.04
- Python: 3.8.0
validations:
required: false

- type: textarea
attributes:
label: Minimal Reproducible Example
description: >
This is referred to by community members as creating a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example).
placeholder: |
```
# Code to reproduce your issue here
```
validations:
required: false

- type: textarea
attributes:
label: Additional
description: Anything else you would like to share?

- type: checkboxes
attributes:
label: Are you willing to submit a PR?
description: >
(Optional) We encourage you to submit a [Pull Request](https://github.com/microsoft/CameraTraps/pulls) (PR) to help contribute Pytorch-Wildlife for everyone, especially if you have a good understanding of how to implement a fix or feature.
options:
- label: Yes I'd like to help by submitting a PR!
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Feature Request
description: Suggest an Enhancement idea
# title: " "
labels: [enhancement]
body:
- type: markdown
attributes:
value: |
Thank you for submitting a Pytorch-Wildlife Feature Request!
- type: checkboxes
attributes:
label: Search before asking
description: >
Please search the [issues](https://github.com/microsoft/CameraTraps/issues) to see if a similar bug report already exists.
options:
- label: >
I have searched the Pytorch-Wildlife [issues](https://github.com/microsoft/CameraTraps/issues) and found no similar bug report.
required: true
- type: textarea
attributes:
label: Description
description: A short description of your feature.
placeholder: |
What new feature would you like to see in Pytorch-Wildlife?
validations:
required: true

- type: textarea
attributes:
label: Use case
description: |
Describe the use case of your feature request. It will help us understand and prioritize the feature request.
placeholder: |
How would this feature be used, and who would use it?
- type: textarea
attributes:
label: Additional
description: Anything else you would like to share?

- type: checkboxes
attributes:
label: Are you willing to submit a PR?
description: >
(Optional) We encourage you to submit a [Pull Request](https://github.com/microsoft/CameraTraps/pulls) (PR) to help contribute Pytorch-Wildlife for everyone, especially if you have a good understanding of how to implement a fix or feature.
options:
- label: Yes I'd like to help by submitting a PR!
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Question
description: Ask a Pytorch-Wildlife question
# title: " "
labels: [question]
body:
- type: markdown
attributes:
value: |
Thank you for asking a general question!
- type: checkboxes
attributes:
label: Search before asking
description: >
Please search the [issues](https://github.com/microsoft/CameraTraps/issues) to see if a similar bug report already exists.
options:
- label: >
I have searched the Pytorch-Wildlife [issues](https://github.com/microsoft/CameraTraps/issues) and found no similar bug report.
required: true
- type: textarea
attributes:
label: Question
description: What is your question?
placeholder: |
💡 ProTip! Include as much information as possible to receive the most helpful response.
validations:
required: true

- type: textarea
attributes:
label: Additional
description: Anything else you would like to share?

0 comments on commit b6ecb7d

Please sign in to comment.