From 89477b5c5e933d37052887f5ad0c6cc4b5be8ae2 Mon Sep 17 00:00:00 2001 From: Mashiro <57566630+HAOCHENYE@users.noreply.github.com> Date: Mon, 19 Dec 2022 14:45:04 +0800 Subject: [PATCH] [Docs] Update issue template of documentation (#822) * update docs template * Update .github/ISSUE_TEMPLATE/3-documentation.yml Co-authored-by: Zaida Zhou <58739961+zhouzaida@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/3-documentation.yml | 37 ++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/3-documentation.yml diff --git a/.github/ISSUE_TEMPLATE/3-documentation.yml b/.github/ISSUE_TEMPLATE/3-documentation.yml new file mode 100644 index 00000000..f39da61c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-documentation.yml @@ -0,0 +1,37 @@ +name: 📚 Documentation +description: Report an issue related to the documentation. +labels: "docs" +title: "[Docs] " + +body: + - type: markdown + attributes: + value: | + ## Note + For general usage questions or idea discussions, please post it to our [**Forum**](https://github.com/open-mmlab/mmengine/discussions) + Please fill in as **much** of the following form as you're able to. **The clearer the description, the shorter it will take to solve it.** + + - type: textarea + attributes: + label: 📚 The doc issue + description: > + A clear and concise description the issue. + validations: + required: true + + - type: textarea + attributes: + label: Suggest a potential alternative/fix + description: > + Tell us how we could improve the documentation in this regard. + + - type: markdown + attributes: + value: | + ## Acknowledgement + Thanks for taking the time to fill out this report. + + If you have already identified the reason, we strongly appreciate you creating a new PR to fix it [**here**](https://github.com/open-mmlab/mmengine/pulls)! + Please refer to [Contribution Guide](https://mmengine.readthedocs.io/en/latest/notes/contributing.html) for contributing. + + Welcome to join our [**Community(TODO)**](https://mmengine.readthedocs.io/en/latest/contact.html) to discuss together. 👬 -- GitLab