[Enhancement] Improve issue template

open-mmlab / mmgeneration

MMGeneration is a powerful toolkit for generative models, based on PyTorch and MMCV.

Apache License 2.0

1.91k stars 232 forks source link

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

To provide a user-friendly and efficient issue-creating experience, this PR improves existing issue templates by using issue forms.

Modification

Use issue forms in .github/ISSUE_TEMPLATE

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:

[x] I have read and followed the workflow indicated in the CONTRIBUTING.md to create this PR.
[x] Pre-commit or linting tools indicated in CONTRIBUTING.md are used to fix the potential lint issues.
[x] Bug fixes are covered by unit tests, the case that causes the bug should be added in the unit tests.
[x] New functionalities are covered by complete unit tests. If not, please add more unit test to ensure the correctness.
[x] The documentation has been modified accordingly, including docstring or example tutorials.

After PR:

[x] If the modification has potential influence on downstream or other related projects, this PR should be tested with some of those projects.
[x] CLA has been signed and all committers have signed the CLA in this PR.

Codecov Report

Base: 74.68% // Head: 74.68% // No change to project coverage :thumbsup:

Coverage data is based on head (7860513) compared to base (1869bcd). Patch has no changes to coverable lines.

:exclamation: Current head 7860513 differs from pull request most recent head 733b388. Consider uploading reports for the commit 733b388 to get more accurate results

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #467 +/- ## ======================================= Coverage 74.68% 74.68% ======================================= Files 145 145 Lines 10914 10914 Branches 2076 2076 ======================================= Hits 8151 8151 Misses 2229 2229 Partials 534 534 ``` | Flag | Coverage Δ | | |---|---|---| | unittests | `74.68% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-mmlab#carryforward-flags-in-the-pull-request-comment) to find out more. Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-mmlab). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=open-mmlab)

open-mmlab / mmgeneration