diff --git a/.github/ISSUE_TEMPLATE/0-bug-report.yml b/.github/ISSUE_TEMPLATE/0-bug-report.yml new file mode 100644 index 0000000000..b22e6e9566 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/0-bug-report.yml @@ -0,0 +1,105 @@ +name: "🐞 Bug report" +description: "Create a report to help us reproduce and fix the bug" +labels: "kind/bug,status/unconfirmed" +title: "[Bug] " + +body: + - type: markdown + attributes: + value: | + If you have already identified the reason, we strongly appreciate you creating a new PR to fix it [here](https://github.com/open-mmlab/mmpose/pulls)! + If this issue is about installing MMCV, please file an issue at [MMCV](https://github.com/open-mmlab/mmcv/issues/new/choose). + If you need our help, please fill in as much of the following form as you're able to. + + **The less clear the description, the longer it will take to solve it.** + + - type: checkboxes + attributes: + label: Prerequisite + description: Please check the following items before creating a new issue. + options: + - label: I have searched [Issues](https://github.com/open-mmlab/mmpose/issues) and [Discussions](https://github.com/open-mmlab/mmpose/discussions) but cannot get the expected help. + required: true + - label: I have read the FAQ documentation ([master](https://mmpose.readthedocs.io/en/latest/faq.html) | [1.x](https://mmpose.readthedocs.io/en/1.x/notes/faq.html)) but cannot get the expected help. + required: true + - label: The bug has not been fixed in the [latest version (master)](https://github.com/open-mmlab/mmpose) or [latest version (1.x)](https://github.com/open-mmlab/mmpose/tree/dev-1.x). + required: true + + - type: dropdown + id: task + attributes: + label: Task + description: The problem arises when + options: + - I'm using the official example scripts/configs for the officially supported tasks/models/datasets. + - I have modified the scripts/configs, or I'm working on my own tasks/models/datasets. + validations: + required: true + + - type: dropdown + id: branch + attributes: + label: Branch + description: The problem arises when I'm working on + options: + - master branch https://github.com/open-mmlab/mmpose + - 1.x branch https://github.com/open-mmlab/mmpose/tree/1.x + validations: + required: true + + + - type: textarea + attributes: + label: Environment + description: | + Please run `python mmpose/utils/collect_env.py` to collect necessary environment information and copy-paste it here. + You may add additional information that may be helpful for locating the problem, such as + - How you installed PyTorch \[e.g., pip, conda, source\] + - Other environment variables that may be related (such as `$PATH`, `$LD_LIBRARY_PATH`, `$PYTHONPATH`, etc.) + validations: + required: true + + - type: textarea + attributes: + label: Reproduces the problem - code sample + description: | + Please provide a code sample that reproduces the problem you ran into. It can be a Colab link or just a code snippet. + placeholder: | + ```python + # Sample code to reproduce the problem + ``` + validations: + required: true + + - type: textarea + attributes: + label: Reproduces the problem - command or script + description: | + What command or script did you run? + placeholder: | + ```shell + The command or script you run. + ``` + validations: + required: true + + - type: textarea + attributes: + label: Reproduces the problem - error message + description: | + Please provide the error message or logs you got, with the full traceback. + placeholder: | + ``` + The error message or logs you got, with the full traceback. + ``` + validations: + required: true + + - type: textarea + attributes: + label: Additional information + description: Tell us anything else you think we should know. + placeholder: | + 1. What's your expected result? + 2. What dataset did you use? + 3. What do you think might be the reason? diff --git a/.github/ISSUE_TEMPLATE/1-feature-request.yml b/.github/ISSUE_TEMPLATE/1-feature-request.yml new file mode 100644 index 0000000000..7547f787bc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-feature-request.yml @@ -0,0 +1,31 @@ +name: 🚀 Feature request +description: Suggest an idea for this project +labels: "kind/enhancement,status/need confirm" +title: "[Feature] " + +body: + - type: markdown + attributes: + value: | + We strongly appreciate you creating a PR to implement this feature [here](https://github.com/open-mmlab/mmpose/pulls)! + If you need our help, please fill in as much of the following form as you're able to. + + **The less clear the description, the longer it will take to solve it.** + + - type: textarea + attributes: + label: What's the feature? + description: | + Tell us more about the feature and how this feature can help. + placeholder: | + E.g., It is inconvenient when \[....\]. + This feature can \[....\]. + validations: + required: true + + - type: textarea + attributes: + label: Any other context? + description: | + Have you considered any alternative solutions or features? If so, what are they? + Also, feel free to add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/2-new-model.yml b/.github/ISSUE_TEMPLATE/2-new-model.yml new file mode 100644 index 0000000000..c786defdab --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-new-model.yml @@ -0,0 +1,32 @@ +name: "\U0001F31F New model/dataset/scheduler addition" +description: Submit a proposal/request to implement a new model / dataset / scheduler +labels: "kind/feature,status/need confirm" +title: "[New Models] " + + +body: + - type: textarea + id: description-request + validations: + required: true + attributes: + label: Model/Dataset/Scheduler description + description: | + Put any and all important information relative to the model/dataset/scheduler + + - type: checkboxes + attributes: + label: Open source status + description: | + Please provide the open-source status, which would be very helpful + options: + - label: "The model implementation is available" + - label: "The model weights are available." + + - type: textarea + id: additional-info + attributes: + label: Provide useful links for the implementation + description: | + Please provide information regarding the implementation, the weights, and the authors. + Please mention the authors by @gh-username if you're aware of their usernames. diff --git a/.github/ISSUE_TEMPLATE/3-documentation.yml b/.github/ISSUE_TEMPLATE/3-documentation.yml new file mode 100644 index 0000000000..6aa8ca24f2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-documentation.yml @@ -0,0 +1,34 @@ +name: 📚 Documentation +description: Report an issue related to the documentation. +labels: "kind/doc,status/need confirm" +title: "[Docs] " + +body: +- type: dropdown + id: branch + attributes: + label: Branch + description: This issue is related to the + options: + - master branch https://mmpose.readthedocs.io/en/latest/ + - 1.x branch https://mmpose.readthedocs.io/en/1.x/ + validations: + required: true + +- 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: > + Thanks for contributing 🎉! diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index ad603359d5..a18c42f124 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,9 +1,12 @@ blank_issues_enabled: false contact_links: - - name: Common Issues - url: https://mmpose.readthedocs.io/en/latest/faq.html - about: Check if your issue already has solutions - - name: MMPose Documentation + - name: 💬 Forum + url: https://github.com/open-mmlab/mmpose/discussions + about: Ask general questions and discuss with other MMPose community members + - name: 📘 MMPose Documentation url: https://mmpose.readthedocs.io/en/latest/ about: Check if your question is answered in docs + - name: 🌐 Explore OpenMMLab + url: https://openmmlab.com/ + about: Get to know more about OpenMMLab diff --git a/.github/ISSUE_TEMPLATE/error-report.md b/.github/ISSUE_TEMPLATE/error-report.md deleted file mode 100644 index 6c7bdea9a1..0000000000 --- a/.github/ISSUE_TEMPLATE/error-report.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -name: Error report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' ---- - -Thanks for your error report and we appreciate it a lot. -If you feel we have helped you, give us a STAR! :satisfied: - -**Checklist** - -1. I have searched related issues but cannot get the expected help. -2. The bug has not been fixed in the latest version. - -**Describe the bug** - -A clear and concise description of what the bug is. - -**Reproduction** - -- What command or script did you run? - -``` -A placeholder for the command. -``` - -- What config did you run? - -``` -A placeholder for the config. -``` - -- Did you make any modifications on the code or config? Did you understand what you have modified? -- What dataset did you use? - -**Environment** - -1. Please run `PYTHONPATH=${PWD}:$PYTHONPATH python mmpose/utils/collect_env.py` to collect necessary environment information and paste it here. -2. You may add addition that may be helpful for locating the problem, such as - -- How you installed PyTorch \[e.g., pip, conda, source\] -- Other environment variables that may be related (such as `$PATH`, `$LD_LIBRARY_PATH`, `$PYTHONPATH`, etc.) - -**Error traceback** - -If applicable, paste the error traceback here. - -``` -A placeholder for traceback. -``` - -**Bug 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! diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index b4ea6903ed..0000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' ---- - -Thanks for your feature request and we will review and plan for it when necessary. -If you feel we have helped you, give us a STAR! :satisfied: - -**Steps** - -1. Check if the feature has been requested in the [meta issue](https://github.com/open-mmlab/mmpose/issues/9), and if so, click thumb up button. -2. Post the feature request in the [meta issue](https://github.com/open-mmlab/mmpose/issues/9), if it is new. - -**Describe the feature** - -**Motivation** - -A clear and concise description of the motivation of the feature. - -1. Ex1. It is inconvenient when \[....\]. -2. Ex2. There is a recent paper \[....\], which is very helpful for \[....\]. - -**Related resources** - -If there is an official code released or third-party implementations, please also provide the information here, which would be very helpful. - -**Additional context** - -Add any other context or screenshots about the feature request here. -If you would like to implement the feature and create a PR, please leave a comment here and that would be much appreciated. diff --git a/.github/ISSUE_TEMPLATE/general_questions.md b/.github/ISSUE_TEMPLATE/general_questions.md deleted file mode 100644 index f02dd63a80..0000000000 --- a/.github/ISSUE_TEMPLATE/general_questions.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -name: General questions -about: Ask general questions to get help -title: '' -labels: '' -assignees: '' ---- diff --git a/.github/ISSUE_TEMPLATE/reimplementation_questions.md b/.github/ISSUE_TEMPLATE/reimplementation_questions.md deleted file mode 100644 index 5e1f91e39f..0000000000 --- a/.github/ISSUE_TEMPLATE/reimplementation_questions.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -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 dataset (e.g., custom datasets). -3. Reimplement a custom model but all the components are implemented in MMPose. -4. Reimplement a custom model with new modules implemented by yourself. - -There are several things to do for different cases as below. - -- For case 1 & 3, please follow the steps in the following sections thus we could help to quick identify the issue. -- For case 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 to the code they write. -- One suggestion for case 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 what the problem you meet and what have you done. - -**Reproduction** - -- What command or script did you run? - -``` -A placeholder for the command. -``` - -- What config dir you run? - -``` -A placeholder for the config. -``` - -- Did you make any modifications on the code or config? Did you understand what you have modified? -- What dataset did you use? - -**Environment** - -1. Please run `PYTHONPATH=${PWD}:$PYTHONPATH python mmpose/utils/collect_env.py` to collect necessary environment information and paste it here. -2. You may add addition that may be helpful for locating the problem, such as - -- How you installed PyTorch \[e.g., pip, conda, source\] -- 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!