Skip to content

Commit 9b1a399

Browse files
author
Jonathan Harper
authored
Update issue templates (#2207)
* Update issue templates Added three issue template types: * bug reports * feature requests * discussion and general questions The focus is on getting sufficient information in bug requests to help us reproduce the issue and communicating that we will be unable to generally support custom environments and participate in general discussions.
1 parent 2befe58 commit 9b1a399

File tree

3 files changed

+60
-0
lines changed

3 files changed

+60
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Bug report
3+
about: Report a bug with ML-Agents
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Screenshots**
21+
If applicable, add screenshots to help explain your problem.
22+
23+
**Environment (please complete the following information):**
24+
- OS + version: [e.g. Windows 10]
25+
- _ML-Agents version_: (e.g. ML-Agents v0.8, or latest `develop` branch from source)
26+
- _Environment_: (which example environment you used to reproduce the error)
27+
28+
**NOTE:** We are unable to help reproduce bugs with custom environments. Please attempt to reproduce your issue with one of the example environments, or provide a minimal patch to one of the environments needed to reproduce the issue.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
name: Discussion / General Questions
3+
about: Discussion about ML-Agents, RL algorithms, or game integrations
4+
title: ''
5+
labels: discussion
6+
assignees: ''
7+
8+
---
9+
10+
Describe what you'd like to discuss.
11+
12+
**Note**: The ML-Agents team has limited resources for education and community discussion. We'll participate as we are able, but encourage members of the community to support one another to discuss and support one another.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: request
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

0 commit comments

Comments
 (0)