Skip to content

Commit

Permalink
[Docs] update issue templates and RTMPose docs (open-mmlab#2270)
Browse files Browse the repository at this point in the history
  • Loading branch information
Tau-J committed Apr 25, 2023
1 parent d427f34 commit 1e239b7
Show file tree
Hide file tree
Showing 7 changed files with 235 additions and 222 deletions.
96 changes: 96 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
name: "🐞 Bug report"
description: "Create a report to help us reproduce and fix the bug"
labels: 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/mmpose/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: 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: The bug has not been fixed in the latest version(https://github.com/open-mmlab/mmpose).
required: true

- type: textarea
attributes:
label: Environment
description: |
Please run following commands and and copy-paste it here:
\- `python -c "from mmpose.utils import collect_env; print(collect_env())"` to collect necessary environment information.
\- `pip list | grep mm` to collect repositories related to OpenMMLab.
\- \[Optional\] 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 screenshots 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 screenshots 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/mmpose/pulls)!
Please refer to [**Contribution Guide**](https://mmpose.readthedocs.io/en/latest/contribution_guide.html) for contributing.
```
56 changes: 0 additions & 56 deletions .github/ISSUE_TEMPLATE/error-report.md

This file was deleted.

75 changes: 42 additions & 33 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,42 @@
---
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.
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/mmpose/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/mmpose/pulls)!
Please refer to [**Contribution Guide**](https://mmpose.readthedocs.io/en/latest/contribution_guide.html) for contributing.
```
70 changes: 0 additions & 70 deletions .github/ISSUE_TEMPLATE/reimplementation_questions.md

This file was deleted.

16 changes: 16 additions & 0 deletions .owners.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
assign:
issues: enabled
pull_requests: disabled
strategy:
# random
daily-shift-based
scedule:
'*/1 * * * *'
assignees:
- Tau-J
- LareinaM
- Ben-Louis
- LareinaM
- Ben-Louis
- Tau-J
- Tau-J
Loading

0 comments on commit 1e239b7

Please sign in to comment.