gaspersic/Gymnasium
1
0
Fork 0
mirror of https://github.com/Farama-Foundation/Gymnasium.git synced 2025-08-02 06:16:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Feature/GitHub issue form (#89)

Browse Source
This commit is contained in:
tobirohrer
2022-10-28 16:22:50 +02:00
committed by GitHub
parent 2a84b99b32
commit 6f94a2a0bf
6 changed files with 119 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
.github/ISSUE_TEMPLATE/bug.md vendored
View File

@@ -1,27 +0,0 @@
---
name: Bug Report
about: Submit a bug report
title: "[Bug Report] Bug title"
---
If you are submitting a bug report, please fill in the following details and use the tag [bug].
**Describe the bug**
A clear and concise description of what the bug is.
**Code example**
Please try to provide a minimal example to reproduce the bug. Error messages and stack traces are also helpful.
**System Info**
Describe the characteristic of your environment:
* Describe how Gymnasium was installed (pip, docker, source, ...)
* What OS/version of Linux you're using. Note that while we will accept PRs to improve Window's support, we do not officially support it.
* Python version
**Additional context**
Add any other context about the problem here.
### Checklist
- [ ] I have checked that there is no similar [issue](https://github.com/Farama-Foundation/Gymnasium/issues) in the repo (**required**)

48
.github/ISSUE_TEMPLATE/bug.yml vendored Normal file
View File

@@ -0,0 +1,48 @@
name: Bug Report
description: Submit a bug report
title: "[Bug Report] Bug title"
labels: ["bug"]
body:
- type: textarea
id: description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
id: code-example
attributes:
label: Code example
description: |
Please try to provide a minimal example to reproduce the bug. Error messages and stack traces are also helpful.
This will be automatically formatted into code, so no need for backticks.
render: shell
- type: textarea
id: system-info
attributes:
label: System info
description: |
Describe the characteristic of your environment:
* Describe how Gymnasium was installed (pip, docker, source, ...)
* Version of `gymnasium` (by `gymnasium.__version__`)
* What OS/version of Linux you're using. Note that while we will accept PRs to improve Window's support, we do not officially support it.
* Python version
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context about the problem here.
- type: checkboxes
id: checklist
attributes:
label: Checklist
options:
- label: >
I have checked that there is no similar [issue](https://github.com/Farama-Foundation/Gymnasium/issues) in
the repo
required: true

33
.github/ISSUE_TEMPLATE/proposal.md vendored
View File

@@ -1,33 +0,0 @@
---
name: Proposal
about: Propose changes that are not fixes bugs
title: "[Proposal] Proposal title"
---
### Proposal
A clear and concise description of the proposal.
### Motivation
Please outline the motivation for the proposal.
Is your feature request related to a problem? e.g.,"I'm always frustrated when [...]".
If this is related to another GitHub issue, please link here too.
### Pitch
A clear and concise description of what you want to happen.
### Alternatives
A clear and concise description of any alternative solutions or features you've considered, if any.
### Additional context
Add any other context or screenshots about the feature request here.
### Checklist
- [ ] I have checked that there is no similar [issue](https://github.com/Farama-Foundation/Gymnasium/issues) in the repo (**required**)

49
.github/ISSUE_TEMPLATE/proposal.yml vendored Normal file
View File

@@ -0,0 +1,49 @@
name: Proposal
description: Propose changes that are not fixing bugs
title: "[Proposal] Proposal title"
labels: ["enhancement"]
body:
- type: textarea
id: proposal
attributes:
label: Proposal
description: A clear and concise description of the proposal.
validations:
required: true
- type: textarea
id: motivation
attributes:
label: Motivation
description: |
Please outline the motivation for the proposal.
Is your feature request related to a problem? e.g.,"I'm always frustrated when [...]".
If this is related to another GitHub issue, please link here too.
- type: textarea
id: pitch
attributes:
label: Pitch
description: A clear and concise description of what you want to happen.
- type: textarea
id: alternatives
attributes:
label: Alternatives
description: A clear and concise description of any alternative solutions or features you've considered, if any.
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
- type: checkboxes
id: checklist
attributes:
label: Checklist
options:
- label: >
I have checked that there is no similar [issue](https://github.com/Farama-Foundation/Gymnasium/issues) in
the repo
required: true

12
.github/ISSUE_TEMPLATE/question.md vendored
View File

@@ -1,12 +0,0 @@
---
name: Question
about: Ask a question
title: "[Question] Question title"
---
### Question
If you're a beginner and have basic questions, please ask on [r/reinforcementlearning](https://www.reddit.com/r/reinforcementlearning/) or in the [RL Discord](https://discord.com/invite/xhfNqQv) (if you're new please use the beginners channel). Basic questions that are not bugs or feature requests will be closed without reply, because GitHub issues are not an appropriate venue for these.
Advanced/nontrivial questions, especially in areas where documentation is lacking, are very much welcome.

22
.github/ISSUE_TEMPLATE/question.yml vendored Normal file
View File

@@ -0,0 +1,22 @@
name: Question
description: Ask a question
title: "[Question] Question title"
labels: ["question"]
body:
- type: markdown
attributes:
value: >
If you're a beginner and have basic questions, please ask on
[r/reinforcementlearning](https://www.reddit.com/r/reinforcementlearning/) or in the
[RL Discord](https://discord.com/invite/xhfNqQv) (if you're new please use the beginners channel).
Basic questions that are not bugs or feature requests will be closed without reply, because GitHub
issues are not an appropriate venue for these. Advanced/nontrivial questions, especially in areas where
documentation is lacking, are very much welcome.
- type: textarea
id: question
attributes:
label: Question
description: Your question
validations:
required: true