From 2aa4100595e74b1f1b67ea0d690a258e8401afa9 Mon Sep 17 00:00:00 2001 From: Ma Zerun Date: Wed, 4 Aug 2021 14:30:20 +0800 Subject: [PATCH] [Docs] Add PR template and modify issue template (#380) * Add language suggestion in issue-template * Add issue template config * Add PR template * Update pr template according to mmcv #1228 --- .github/ISSUE_TEMPLATE/----.md | 2 ++ .github/ISSUE_TEMPLATE/---.md | 6 ++++-- .github/ISSUE_TEMPLATE/---bug.md | 2 ++ .github/ISSUE_TEMPLATE/--.md | 28 --------------------------- .github/ISSUE_TEMPLATE/config.yml | 6 ++++++ .github/pull_request_template.md | 32 +++++++++++++++++++++++++++++++ 6 files changed, 46 insertions(+), 30 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/--.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/----.md b/.github/ISSUE_TEMPLATE/----.md index 5a7bd0b9..bd1427fb 100644 --- a/.github/ISSUE_TEMPLATE/----.md +++ b/.github/ISSUE_TEMPLATE/----.md @@ -7,6 +7,8 @@ assignees: '' --- +推荐使用英语模板 General question，以便你的问题帮助更多人。 + ### 首先确认以下内容 - 我已经查询了相关的 issue，但没有找到需要的帮助。 - 我已经阅读了相关文档，但仍不知道如何解决。 diff --git a/.github/ISSUE_TEMPLATE/---.md b/.github/ISSUE_TEMPLATE/---.md index 9f23e48e..c8d2880c 100644 --- a/.github/ISSUE_TEMPLATE/---.md +++ b/.github/ISSUE_TEMPLATE/---.md @@ -7,14 +7,16 @@ assignees: '' --- +推荐使用英语模板 Feature request，以便你的问题帮助更多人。 + ### 描述这个功能 [填写这里] ### 动机 请简要说明以下为什么需要添加这个新功能 -例1. 现在进行 xxx 的时候不方便 -例2. 最近的论文中提出了有一个很有帮助的 xx +例 1. 现在进行 xxx 的时候不方便 +例 2. 最近的论文中提出了有一个很有帮助的 xx [填写这里] diff --git a/.github/ISSUE_TEMPLATE/---bug.md b/.github/ISSUE_TEMPLATE/---bug.md index 4d49a361..21439b1a 100644 --- a/.github/ISSUE_TEMPLATE/---bug.md +++ b/.github/ISSUE_TEMPLATE/---bug.md @@ -7,6 +7,8 @@ assignees: '' --- +推荐使用英语模板 Bug report，以便你的问题帮助更多人。 + ### 描述 bug 简单地描述一下遇到了什么 bug diff --git a/.github/ISSUE_TEMPLATE/--.md b/.github/ISSUE_TEMPLATE/--.md deleted file mode 100644 index a23cae85..00000000 --- a/.github/ISSUE_TEMPLATE/--.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -name: 提问 -about: 遇到问题并寻求帮助 -title: '' -labels: help wanted -assignees: '' - ---- - -### 首先确认以下内容 -- 我已经查询了相关的 issue，但没有找到需要的帮助。 -- 我已经阅读了相关文档，但仍不知道如何解决。 - -### 描述你遇到的问题 - -[填写这里] - -### 相关信息 -1. `pip list | grep "mmcv\|mmcls\|^torch"` 命令的输出 -[填写这里] -2. 如果你修改了，或者使用了新的配置文件，请在这里写明 -```python -[填写这里] -``` -3. 如果你是在训练过程中遇到的问题，请填写完整的训练日志和报错信息 -[填写这里] -4. 如果你对 `mmcls` 文件夹下的代码做了其他相关的修改，请在这里写明 -[填写这里] diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..ca2a4926 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,6 @@ +blank_issues_enabled: false + +contact_links: + - name: MMClassification Documentation + url: https://mmclassification.readthedocs.io/en/latest/ + about: Check if your question is answered in docs diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..3eeae910 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,32 @@ +Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers. + +## Motivation + +Please describe the motivation of this PR and the goal you want to achieve through this PR. + +## Modification + +Please briefly describe what modification is made in this PR. + +## BC-breaking (Optional) + +Does the modification introduce changes that break the backward compatibility of the downstream repositories? +If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR. + +## Use cases (Optional) + +If this PR introduces a new feature, it is better to list some use cases here and update the documentation. + +## Checklist + +**Before PR**: + +- [ ] Pre-commit or other linting tools are used to fix the potential lint issues. +- [ ] Bug fixes are fully covered by unit tests, the case that causes the bug should be added in the unit tests. +- [ ] The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness. +- [ ] The documentation has been modified accordingly, like docstring or example tutorials. + +**After PR**: + +- [ ] If the modification has potential influence on downstream or other related projects, this PR should be tested with those projects, like MMDet or MMSeg. +- [ ] CLA has been signed and all committers have signed the CLA in this PR.