[Enhance] Update issue template (#2503)

* [Docs] Update link of registry tutorial (#2442)

Registry docs are now under Advanced Tutorials.

* update issue template

* update config.yml

---------
Co-authored-by: pd-michaelstanley <88335018+pd-michaelstanley@users.noreply.github.com>

.github/ISSUE_TEMPLATE/1-bug-report.yml

+name: "🐞 Bug report"
+description: "Create a report to help us reproduce and fix the bug"
+labels: kind/bug
+title: "[Bug] "
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## Note
+        For general usage questions or idea discussions, please post it to our [**Forum**](https://github.com/open-mmlab/mmdetection3d/discussions).
+        If this issue is about installing MMCV, please file an issue at [MMCV](https://github.com/open-mmlab/mmcv/issues/new/choose).
+        If it's anything about model deployment, please raise it to [MMDeploy](https://github.com/open-mmlab/mmdeploy).
+
+        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: 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/mmdetection3d/issues) and [Discussions](https://github.com/open-mmlab/mmdetection3d/discussions) but cannot get the expected help.
+        required: true
+      - label: I have read the [FAQ documentation](https://mmdetection3d.readthedocs.io/en/latest/notes/faq.html) but cannot get the expected help.
+        required: true
+      - label: The bug has not been fixed in the [latest version (dev-1.x)](https://github.com/open-mmlab/mmdetection3d/tree/dev-1.x) or [latest version (dev-1.0)](https://github.com/open-mmlab/mmdetection3d/tree/dev-1.0).
+        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:
+        - main branch https://github.com/open-mmlab/mmdetection3d
+        - 1.x branch https://github.com/open-mmlab/mmdetection3d/tree/dev-1.x
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Environment
+      description: |
+        Please run `python mmdet3d/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.
+
+        Tip: You can attach images or log files by dragging them into the text area..
+      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.
+
+        Tip: You can attach images or log files by dragging them into the text area.
+      placeholder: |
+        1. What's your expected result?
+        2. What dataset did you use?
+        3. What do you think might be the reason?
+
+  - 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/mmdetection3d/pulls)!
+        Please refer to [**Contribution Guide**](https://mmdetection3d.readthedocs.io/en/latest/notes/contribution_guides.html) for contributing.

.github/ISSUE_TEMPLATE/2-feature_request.yml

+name: 🚀 Feature request
+description: Suggest an idea for this project
+labels: [feature-request]
+title: "[Feature] "
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## Note
+        For general usage questions or idea discussions, please post it to our [**Forum**](https://github.com/open-mmlab/mmdetection3d/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: What is the feature?
+      description: Tell us more about the feature and how this feature can help.
+      placeholder: |
+        E.g., It is inconvenient when \[....\].
+    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.
+
+  - type: markdown
+    attributes:
+      value: |
+        ## Acknowledgement
+        Thanks for taking the time to fill out this report.
+
+        We strongly appreciate you creating a new PR to implement it [**Here**](https://github.com/open-mmlab/mmdetection3d/pulls)!
+        Please refer to [**Contribution Guide**](https://mmdetection3d.readthedocs.io/en/latest/notes/contribution_guides.html) for contributing.

.github/ISSUE_TEMPLATE/3-new-model.yml

+name: "\U0001F31F New model/dataset/scheduler addition"
+description: Submit a proposal/request to implement a new model / dataset / scheduler
+labels: [ "feature-request" ]
+title: "[New Models] "
+
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## Note
+        For general usage questions or idea discussions, please post it to our [**Forum**](https://github.com/open-mmlab/mmdetection3d/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
+    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.
+
+  - type: markdown
+    attributes:
+      value: |
+        ## Acknowledgement
+        Thanks for taking the time to fill out this report.
+
+        We strongly appreciate you creating a new PR to implement it [**Here**](https://github.com/open-mmlab/mmdetection3d/pulls)!
+        Please refer to [**Contribution Guide**](https://mmdetection3d.readthedocs.io/en/latest/notes/contribution_guides.html) for contributing.

.github/ISSUE_TEMPLATE/4-documentation.yml

+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/mmdetection3d/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: dropdown
+    id: branch
+    attributes:
+      label: Branch
+      description: This issue is related to the
+      options:
+        - main branch  https://mmdetection3d.readthedocs.io/en/latest/
+        - dev-1.x branch https://mmdetection3d.readthedocs.io/en/dev-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: |
+        ## 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/mmdetection3d/pulls)!
+        Please refer to [**Contribution Guide**](https://mmdetection3d.readthedocs.io/en/latest/notes/contribution_guides.html) for contributing.

.github/ISSUE_TEMPLATE/config.yml

 blank_issues_enabled: false
+
+contact_links:
+  - name: Common Issues
+    url: https://mmdetection3d.readthedocs.io/en/latest/notes/faq.html
+    about: Check if your issue already has solutions
+  - name: MMDet3D Documentation
+    url: https://mmdetection3d.readthedocs.io/en/latest/
+    about: Check if your question is answered in docs

.github/ISSUE_TEMPLATE/error-report.md

----
-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.
-
-**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**
-
-1. What command or script did you run?
-
-```
-A placeholder for the command.
-```
-
-2. Did you make any modifications on the code or config? Did you understand what you have modified?
-3. What dataset did you use?
-
-**Environment**
-
-1. Please run `python mmdet3d/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 trackback here.
-
-```
-A placeholder for trackback.
-```
-
-**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!

.github/ISSUE_TEMPLATE/feature_request.md

----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
----
-
-**Describe the feature**
-
-**Motivation**
-A clear and concise description of the motivation of the feature.
-Ex1. It is inconvenient when \[....\].
-Ex2. There is a recent paper \[....\], which is very helpful for \[....\].
-
-**Related resources**
-If there is an official code release 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.

.github/ISSUE_TEMPLATE/general_questions.md

----
-name: General questions
-about: Ask general questions to get help
-title: ''
-labels: ''
-assignees: ''
----

.github/ISSUE_TEMPLATE/reimplementation_questions.md

----
-name: Reimplementation Questions
-about: Ask about questions during model reimplementation
-title: ''
-labels: reimplementation
-assignees: ''
----
-
-**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 MMDetection3D
-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-implemted 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**
-
-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 on the code or config? Did you understand what you have modified?
-4. What dataset did you use?
-
-**Environment**
-
-1. Please run `python mmdet3d/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!

docs/en/notes/index.rst

@@ -6,3 +6,4 @@
    changelog.md
    compatibility.md
    faq.md
+   contribution_guides.md

mmdet3d/utils/setup_env.py

@@ -64,7 +64,7 @@ def register_all_modules(init_default_scope: bool = True) -> None:
             When `init_default_scope=True`, the global default scope will be
             set to `mmdet3d`, and all registries will build modules from mmdet3d's
             registry node. To understand more about the registry, please refer
-            to https://github.com/open-mmlab/mmengine/blob/main/docs/en/tutorials/registry.md
+            to https://github.com/open-mmlab/mmengine/blob/main/docs/en/advanced_tutorials/registry.md
             Defaults to True.
     """  # noqa
     import mmdet3d.datasets  # noqa: F401,F403

pytorch-sphinx-theme @ cf1aa23d

+Subproject commit cf1aa23d2621c6ebe7f5c0b8e7ecd23a82300f3b