From 8ed5975b81ba0f2e93137d3a1e2488c729fc9edd Mon Sep 17 00:00:00 2001
From: Junjun2016 <hejunjun@sjtu.edu.cn>
Date: Sun, 1 Aug 2021 00:29:15 +0800
Subject: [PATCH] add reimplementation questions template (#741)

---
 .../reimplementation_questions.md             | 70 +++++++++++++++++++
 1 file changed, 70 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/reimplementation_questions.md

diff --git a/.github/ISSUE_TEMPLATE/reimplementation_questions.md b/.github/ISSUE_TEMPLATE/reimplementation_questions.md
new file mode 100644
index 0000000000..c82397baed
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/reimplementation_questions.md
@@ -0,0 +1,70 @@
+---
+name: Reimplementation Questions
+about: Ask about questions during model reimplementation
+title: ''
+labels: 'reimplementation'
+assignees: ''
+
+---
+
+If you feel we have helped you, give us a STAR! :satisfied:
+
+**Notice**
+
+There are several common situations in the reimplementation issues as below
+
+1. Reimplement a model in the model zoo using the provided configs
+2. Reimplement a model in the model zoo on other datasets (e.g., custom datasets)
+3. Reimplement a custom model but all the components are implemented in MMSegmentation
+4. Reimplement a custom model with new modules implemented by yourself
+
+There are several things to do for different cases as below.
+
+- For cases 1 & 3, please follow the steps in the following sections thus we could help to quickly identify the issue.
+- For cases 2 & 4, please understand that we are not able to do much help here because we usually do not know the full code, and the users should be responsible for the code they write.
+- One suggestion for cases 2 & 4 is that the users should first check whether the bug lies in the self-implemented code or the original code. For example, users can first make sure that the same model runs well on supported datasets. If you still need help, please describe what you have done and what you obtain in the issue, and follow the steps in the following sections, and try as clear as possible so that we can better help you.
+
+**Checklist**
+
+1. I have searched related issues but cannot get the expected help.
+2. The issue has not been fixed in the latest version.
+
+**Describe the issue**
+
+A clear and concise description of the problem you meet and what you have done.
+
+**Reproduction**
+
+1. What command or script did you run?
+
+```
+A placeholder for the command.
+```
+
+2. What config dir you run?
+
+```
+A placeholder for the config.
+```
+
+3. Did you make any modifications to the code or config? Did you understand what you have modified?
+4. What dataset did you use?
+
+**Environment**
+
+1. Please run `PYTHONPATH=${PWD}:$PYTHONPATH python mmseg/utils/collect_env.py` to collect the necessary environment information and paste it here.
+2. You may add an addition that may be helpful for locating the problem, such as
+   1. How you installed PyTorch [e.g., pip, conda, source]
+   2. Other environment variables that may be related (such as `$PATH`, `$LD_LIBRARY_PATH`, `$PYTHONPATH`, etc.)
+
+**Results**
+
+If applicable, paste the related results here, e.g., what you expect and what you get.
+
+```
+A placeholder for results comparison
+```
+
+**Issue fix**
+
+If you have already identified the reason, you can provide the information here. If you are willing to create a PR to fix it, please also leave a comment here and that would be much appreciated!