Skip to content

Commit 3663174

Browse files
qgallouedecaraffin
qgallouedec
and
araffin
authored
Use issue forms (#302)
* Issue form * Update changelog * black * Add RL Zoo README Co-authored-by: Antonin Raffin <antonin.raffin@dlr.de>
1 parent cd32262 commit 3663174

File tree

7 files changed

+172
-27
lines changed

7 files changed

+172
-27
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: "\U0001F41B Bug Report"
2+
description: Submit a bug report to help us improve RL Baselines3 Zoo
3+
title: "[Bug]: bug title"
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
**Important Note: We do not do technical support, nor consulting** and don't answer personal questions per email.
10+
Please post your question on the [RL Discord](https://discord.com/invite/xhfNqQv), [Reddit](https://www.reddit.com/r/reinforcementlearning/) or [Stack Overflow](https://stackoverflow.com/) in that case.
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: 🐛 Bug
15+
description: A clear and concise description of what the bug is.
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: reproduce
20+
attributes:
21+
label: To Reproduce
22+
description: |
23+
Steps to reproduce the behavior. Please try to provide a minimal example to reproduce the bug. Error messages and stack traces are also helpful.
24+
Please use the [markdown code blocks](https://help.github.com/en/articles/creating-and-highlighting-code-blocks) for both code and stack traces.
25+
value: |
26+
```shell
27+
python train.py --algo ...
28+
```
29+
30+
- type: textarea
31+
id: traceback
32+
attributes:
33+
label: Relevant log output / Error message
34+
description: Please copy and paste any relevant log output / error message. This will be automatically formatted into code, so no need for backticks.
35+
placeholder: "Traceback (most recent call last): File ..."
36+
render: shell
37+
38+
- type: textarea
39+
id: system-info
40+
attributes:
41+
label: System Info
42+
description: |
43+
Describe the characteristic of your environment:
44+
* Describe how the library was installed (pip, docker, source, ...)
45+
* GPU models and configuration
46+
* Python version
47+
* PyTorch version
48+
* Gym version
49+
* Versions of any other relevant libraries
50+
51+
You can use `sb3.get_system_info()` to print relevant packages info:
52+
```python
53+
import stable_baselines3 as sb3
54+
sb3.get_system_info()
55+
```
56+
- type: checkboxes
57+
id: terms
58+
attributes:
59+
label: Checklist
60+
options:
61+
- label: I have checked that there is no similar [issue](https://github.com/DLR-RM/rl-baselines3-zoo/issues) in the repo
62+
required: true
63+
- label: I have read the [SB3 documentation](https://stable-baselines3.readthedocs.io/en/master/)
64+
required: true
65+
- label: I have read the [RL Zoo README](https://github.com/DLR-RM/rl-baselines3-zoo/blob/master/README.md)
66+
required: true
67+
- label: I have provided a minimal working example to reproduce the bug
68+
required: true
69+
- label: I've used the [markdown code blocks](https://help.github.com/en/articles/creating-and-highlighting-code-blocks) for both code and stack traces.
70+
required: true

‎.github/ISSUE_TEMPLATE/documentation.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: "\U0001F4DA Documentation"
2+
description: Report an issue related to RL Baselines3 Zoo documentation
3+
labels: ["documentation"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
**Important Note: We do not do technical support, nor consulting** and don't answer personal questions per email.
9+
Please post your question on the [RL Discord](https://discord.com/invite/xhfNqQv), [Reddit](https://www.reddit.com/r/reinforcementlearning/) or [Stack Overflow](https://stackoverflow.com/) in that case.
10+
- type: textarea
11+
id: description
12+
attributes:
13+
label: 📚 Documentation
14+
description: A clear and concise description of what should be improved in the documentation.
15+
validations:
16+
required: true
17+
- type: checkboxes
18+
id: terms
19+
attributes:
20+
label: Checklist
21+
options:
22+
- label: I have checked that there is no similar [issue](https://github.com/DLR-RM/rl-baselines3-zoo/issues) in the repo
23+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: "\U0001F680 Feature Request"
2+
description: How to create an issue for requesting a feature
3+
title: "[Feature Request] request title"
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
**Important Note: We do not do technical support, nor consulting** and don't answer personal questions per email.
10+
Please post your question on the [RL Discord](https://discord.com/invite/xhfNqQv), [Reddit](https://www.reddit.com/r/reinforcementlearning/) or [Stack Overflow](https://stackoverflow.com/) in that case.
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: 🚀 Feature
15+
description: A clear and concise description of the feature proposal.
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: motivation
20+
attributes:
21+
label: Motivation
22+
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.
23+
- type: textarea
24+
id: pitch
25+
attributes:
26+
label: Pitch
27+
description: A clear and concise description of what you want to happen.
28+
- type: textarea
29+
id: alternatives
30+
attributes:
31+
label: Alternatives
32+
description: A clear and concise description of any alternative solutions or features you've considered, if any.
33+
- type: textarea
34+
id: additional-context
35+
attributes:
36+
label: Additional context
37+
description: Add any other context or screenshots about the feature request here.
38+
- type: checkboxes
39+
id: terms
40+
attributes:
41+
label: Checklist
42+
options:
43+
- label: I have checked that there is no similar [issue](https://github.com/DLR-RM/rl-baselines3-zoo/issues) in the repo
44+
required: true

‎.github/ISSUE_TEMPLATE/issue-template.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/question.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: "❓ Question"
2+
description: How to ask a question regarding RL Baselines3 Zoo
3+
title: "[Question] question title"
4+
labels: ["question"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
**Important Note: We do not do technical support, nor consulting** and don't answer personal questions per email.
10+
Please post your question on the [RL Discord](https://discord.com/invite/xhfNqQv), [Reddit](https://www.reddit.com/r/reinforcementlearning/) or [Stack Overflow](https://stackoverflow.com/) in that case.
11+
- type: textarea
12+
id: question
13+
attributes:
14+
label: ❓ Question
15+
description: Your question. This can be e.g. questions regarding confusing or unclear behaviour of functions or a question if X can be done using rl-baselines3-zoo. Make sure to check out the documentation first.
16+
validations:
17+
required: true
18+
- type: checkboxes
19+
id: terms
20+
attributes:
21+
label: Checklist
22+
options:
23+
- label: I have checked that there is no similar [issue](https://github.com/DLR-RM/rl-baselines3-zoo/issues) in the repo
24+
required: true
25+
- label: I have read the [SB3 documentation](https://stable-baselines3.readthedocs.io/en/master/)
26+
required: true
27+
- label: I have read the [RL Zoo README](https://github.com/DLR-RM/rl-baselines3-zoo/blob/master/README.md)
28+
required: true
29+
- label: If code there is, it is minimal and working
30+
required: true
31+
- label: If code there is, it is formatted using the [markdown code blocks](https://help.github.com/en/articles/creating-and-highlighting-code-blocks) for both code and stack traces.
32+
required: true

‎CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
- Added instructions and examples on passing arguments in an interactive session (@richter43)
1212

1313
### Other
14+
- Used issue forms instead of issue templates
1415

1516
## Release 1.6.2.post2 (2022-10-10)
1617

‎rl_zoo3/train.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,5 +254,6 @@ def train():
254254
else:
255255
exp_manager.hyperparameters_optimization()
256256

257-
if __name__ == '__main__':
257+
258+
if __name__ == "__main__":
258259
train()

0 commit comments

Comments
 (0)