mirror of
https://github.com/JDAI-CV/fast-reid.git
synced 2025-06-03 14:50:47 +08:00
update issue template
This commit is contained in:
parent
3f35eb449d
commit
ef92e63f34
36
.github/ISSUE_TEMPLATE/bugs.md
vendored
Normal file
36
.github/ISSUE_TEMPLATE/bugs.md
vendored
Normal file
@ -0,0 +1,36 @@
|
||||
---
|
||||
name: "🐛 Bugs"
|
||||
about: Report bugs in fastreid
|
||||
title: Please read & provide the following
|
||||
|
||||
---
|
||||
|
||||
## Instructions To Reproduce the 🐛 Bug:
|
||||
|
||||
1. what changes you made (`git diff`) or what code you wrote
|
||||
```
|
||||
<put diff or code here>
|
||||
```
|
||||
2. what exact command you run:
|
||||
3. what you observed (including __full logs__):
|
||||
```
|
||||
<put logs here>
|
||||
```
|
||||
4. please simplify the steps as much as possible so they do not require additional resources to
|
||||
run, such as a private dataset.
|
||||
|
||||
## Expected behavior:
|
||||
|
||||
If there are no obvious error in "what you observed" provided above,
|
||||
please tell us the expected behavior.
|
||||
|
||||
## Environment:
|
||||
|
||||
Provide your environment information using the following command:
|
||||
|
||||
```
|
||||
wget -nc -q https://github.com/facebookresearch/detectron2/raw/master/detectron2/utils/collect_env.py && python collect_env.py
|
||||
```
|
||||
|
||||
If your issue looks like an installation issue / environment issue,
|
||||
please first try to solve it yourself with the instructions in
|
9
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
9
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@ -0,0 +1,9 @@
|
||||
# require an issue template to be chosen
|
||||
blank_issues_enabled: false
|
||||
|
||||
# Unexpected behaviors & bugs are split to two templates.
|
||||
# When they are one template, users think "it's not a bug" and don't choose the template.
|
||||
#
|
||||
# But the file name is still "unexpected-problems-bugs.md" so that old references
|
||||
# to this issue template still works.
|
||||
# It's ok since this template should be a superset of "bugs.md" (unexpected behaviors is a superset of bugs)
|
22
.github/ISSUE_TEMPLATE/questions-help-support.md
vendored
Normal file
22
.github/ISSUE_TEMPLATE/questions-help-support.md
vendored
Normal file
@ -0,0 +1,22 @@
|
||||
---
|
||||
name: "How to do something❓"
|
||||
about: How to do something using fastreid? What does an API do?
|
||||
|
||||
---
|
||||
|
||||
## ❓ How to do something using fastreid
|
||||
|
||||
Describe what you want to do, including:
|
||||
|
||||
1. what inputs you will provide, if any:
|
||||
2. what outputs you are expecting:
|
||||
|
||||
NOTE:
|
||||
|
||||
1. Only general answers are provided.
|
||||
If you want to ask about "why X did not work", please use the
|
||||
[Unexpected behaviors]() issue template.
|
||||
|
||||
2. About how to implement new models / new dataloader / new training logic, etc., check documentation first.
|
||||
|
||||
3. We do not answer general machine learning / computer vision questions that are not specific to fastreid, such as how a model works, how to improve your training/make it converge, or what algorithm/methods can be used to achieve X.
|
35
.github/ISSUE_TEMPLATE/unexpected-problems-bugs.md
vendored
Normal file
35
.github/ISSUE_TEMPLATE/unexpected-problems-bugs.md
vendored
Normal file
@ -0,0 +1,35 @@
|
||||
---
|
||||
name: "Unexpected behaviors"
|
||||
about: Run into unexpected behaviors when using fastreid
|
||||
title: Please read & provide the following
|
||||
|
||||
---
|
||||
|
||||
If you do not know the root cause of the problem, and wish someone to help you, please
|
||||
post according to this template:
|
||||
|
||||
## Instructions To Reproduce the Issue:
|
||||
|
||||
Check https://stackoverflow.com/help/minimal-reproducible-example for how to ask good questions.
|
||||
Simplify the steps to reproduce the issue using suggestions from the above link, and provide them below:
|
||||
|
||||
1. full code you wrote or full changes you made (`git diff`)
|
||||
```
|
||||
<put code or diff here>
|
||||
```
|
||||
2. what exact command you run:
|
||||
3. __full logs__ you observed:
|
||||
```
|
||||
<put logs here>
|
||||
```
|
||||
|
||||
## Expected behavior:
|
||||
|
||||
If there are no obvious error in "what you observed" provided above,
|
||||
please tell us the expected behavior.
|
||||
|
||||
If you expect the model to converge / work better, note that we do not give suggestions
|
||||
on how to train a new model.
|
||||
Only in one of the two conditions we will help with it:
|
||||
(1) You're unable to reproduce the results in fastreid model zoo.
|
||||
(2) It indicates a fastreid bug.
|
Loading…
x
Reference in New Issue
Block a user