Skip to content

Commit

Permalink
adding issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
reginald-mclean committed Sep 5, 2024
1 parent 50f9a21 commit 35f20b6
Show file tree
Hide file tree
Showing 3 changed files with 118 additions and 0 deletions.
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -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
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/proposal.yml
Original file line number Diff line number Diff line change
@@ -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
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
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

0 comments on commit 35f20b6

Please sign in to comment.