Skip to content

Commit

Permalink
Issues templates (facebookresearch#1662)
Browse files Browse the repository at this point in the history
* Initial issue templates.

* Tweak.

* Update with comments from Kurt and Jack.

* More capitalization consistency.
  • Loading branch information
stephenroller authored Apr 22, 2019
1 parent 1b4f655 commit 324d712
Show file tree
Hide file tree
Showing 5 changed files with 114 additions and 0 deletions.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/agent-bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: "[Agent Bug]"
about: Reporting problems or unexpected behavior with an Agent or pretrained model.

---

**Bug description**
Please enter a clear and concise description of what the bug is.

**Reproduction steps**
Enter steps to reproduce the behavior.

**Expected behavior**
Give a clear and concise description of what you expected to happen.

**Logs**
Please paste the command line output:

```
Output goes here
```

**Additional context**
Add any other context about the problem here. (like proxy settings, network setup, overall goals, etc.)
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: "[Feature Request]"
about: Suggest an idea for this project

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/mturk-bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: "[MTurk]"
about: Reporting problems or unexpected behavior with MTurk

---

**Bug description**
Please enter a clear and concise description of what the bug is.

**Reproduction steps**
Enter steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
Give a clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem. You may drag-and-drop
screenshots onto the Github Descrption field to upload an image.
(More information is available here:
https://gist.github.com/vinkla/dca76249ba6b73c5dd66a4e986df4c8d)

**Client logs:**
For issues that make it to the point of reaching the frontend in a browser,
please include the javascript logs from that browser. In Chrome, javascript
logs can be found via View -> Developer -> JavaScript Console.

**CLI logs:**
Please include the CLI logs for all issues. If you have access to the heroku logs
and think they are relevant, please also include them.

**Additional context**
Add any other context about the problem here (e.g. proxy settings, network
setup, overall goals).
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/other.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
name: "[Other]"
about: For anything else you want an issue for

---

Use this to open other questions or issues, and provide context here.
29 changes: 29 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: "[Pull Request]"
about: Submitting a pull request

---

**Patch description**
Please enter a clear and concise description of what your pull request does, and why
it is necessary. If your patch fixes an issue, please reference that issue here.

**Testing steps**
Enter steps to test your pull request:

**Expected behavior**
Give a clear and concise description of what you expected to happen during testing.

**Logs**
If applicable, please paste the command line from your testing:

```
Output goes here
```

**Other information**
Any other information or context you would like to provide.

**Data tests (if applicable)**
If you added a new teacher, you will be asked to run
`python setup.py -s tests.suites.datatests`. Please paste this log here.

0 comments on commit 324d712

Please sign in to comment.