From cc96cd8785a52b1a31323a396e00c8a0030a41aa Mon Sep 17 00:00:00 2001
From: zqwerty <zhuq96@hotmail.com>
Date: Wed, 22 Jun 2022 16:22:32 +0800
Subject: [PATCH] update github issue& pr template

---
 .github/ISSUE_TEMPLATE/bug_report.md          |  3 +++
 .github/PULL_REQUEST_TEMPLATE/add_datasets.md | 16 +++++++++++++
 .github/PULL_REQUEST_TEMPLATE/add_model.md    | 15 ++++++++++++
 .../PULL_REQUEST_TEMPLATE/custom.md           |  0
 .github/PULL_REQUEST_TEMPLATE/fix_bug.md      | 23 +++++++++++++++++++
 5 files changed, 57 insertions(+)
 create mode 100644 .github/PULL_REQUEST_TEMPLATE/add_datasets.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE/add_model.md
 rename PULL_REQUEST_TEMPLATE.md => .github/PULL_REQUEST_TEMPLATE/custom.md (100%)
 create mode 100755 .github/PULL_REQUEST_TEMPLATE/fix_bug.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index bdce7faa..a7cbfda0 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -20,5 +20,8 @@ Steps to reproduce the behavior:
 **Expected behavior**
 A clear and concise description of what you expected to happen.
 
+**Actual behavior**
+A clear and concise description of the actual results.
+
 **Additional context**
 Add any other context about the problem here.
diff --git a/.github/PULL_REQUEST_TEMPLATE/add_datasets.md b/.github/PULL_REQUEST_TEMPLATE/add_datasets.md
new file mode 100644
index 00000000..dfb3ea10
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/add_datasets.md
@@ -0,0 +1,16 @@
+- **Name:** *name of the dataset*
+- **Description:** *short description of the dataset (or link to social media or blog post)*
+- **Paper:** *link to the dataset paper if available*
+- **Data:** *link to the Github repository or current dataset location*
+- **License:** *what is the license of the dataset*
+- **Motivation:** *what are some good reasons to have this dataset*
+
+
+### Checkbox
+
+- [ ] Create `data/unified_datasets/$dataset_name` folder, where `$dataset_name` is the name of the dataset.
+- [ ] Create the dataset scripts under `data/unified_datasets/$dataset_name` following `data/unified_datasets/README.md`.
+- [ ] Run `python check.py $dataset` in the `data/unified_datasets` directory to check the validation of processed dataset and get data statistics and shuffled dialog ids.
+- [ ] Add the dataset card `data/unified_datasets/$dataset_name/README.md` following `data/unified_datasets/README_TEMPLATE.md`.
+- [ ] Upload the data, scripts, and dataset card to https://huggingface.co/ConvLab
+- [ ] Update `NOTICE` with license information.
diff --git a/.github/PULL_REQUEST_TEMPLATE/add_model.md b/.github/PULL_REQUEST_TEMPLATE/add_model.md
new file mode 100644
index 00000000..387b0244
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/add_model.md
@@ -0,0 +1,15 @@
+- **Name:** *name of the model*
+- **Description:** *short description of the model (or link to social media or blog post)*
+- **Paper:** *link to the model paper if available*
+- **Repo:** *link to the Github repository of official implementation*
+- **License:** *what is the license of the code*
+- **Motivation:** *what are some good reasons to have this model*
+
+
+### Checkbox
+
+- [ ] The model supports unified data format and provides training scripts.
+- [ ] The model has implemented module interface and can be used to build an agent (Add examples in `agent_examples`).
+- [ ] Add the model card `README` under its directory.
+- [ ] Upload the checkpoints, and model card to https://huggingface.co/ConvLab
+- [ ] Update `NOTICE` with license information.
diff --git a/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE/custom.md
similarity index 100%
rename from PULL_REQUEST_TEMPLATE.md
rename to .github/PULL_REQUEST_TEMPLATE/custom.md
diff --git a/.github/PULL_REQUEST_TEMPLATE/fix_bug.md b/.github/PULL_REQUEST_TEMPLATE/fix_bug.md
new file mode 100755
index 00000000..719d39e9
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/fix_bug.md
@@ -0,0 +1,23 @@
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Actual behavior**
+A clear and concise description of the actual results.
+
+**Additional context**
+Add any other context about the problem here.
+
+**How to fix**
+Changes made to fix the bug.
+
+**Reference Issues:** #XX (XX is the issue number you work on)
-- 
GitLab