diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 5d4c59d9..f93aee55 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,31 +7,30 @@ assignees: '' --- -**_If you like the repo, please give it a :star:_** + ## Description - -Short description of the problem here. + ## Context -How has this bug affected you? What were you trying to accomplish? + ## Steps to Reproduce -Please provide a detailed description. A Minimal Reproducible Example would really help to solve your issue faster (see this [Stack Overflow thread](https://stackoverflow.com/help/minimal-reproducible-example) to see how to create a good "reprex"). A link to a github repo is even better. + ## Expected Result -Tell us what should happen. + ## Actual Result -Tell us what happens instead. + ``` -- If you received an error, place it here. @@ -43,7 +42,7 @@ Tell us what happens instead. ## Your Environment -Include as many relevant details about the environment in which you experienced the bug: + * `kedro` and `kedro-mlflow` version used (`pip show kedro` and `pip show kedro-mlflow`): * Python version used (`python -V`): @@ -51,7 +50,7 @@ Include as many relevant details about the environment in which you experienced ## Does the bug also happen with the last version on master? -The plugin is still in early development and known bugs are fixed as soon as we can. If you are lucky, your bug is already fixed on the `master` branch which is the most up to date. This branch contains our more recent development unpublished on PyPI yet. + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 6b85060f..2b0c9a17 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -6,16 +6,16 @@ labels: 'Issue: Feature Request' assignees: '' --- -*If you like the repo, please give it a :star:* + ## Description -A clear and concise description of what you want to achieve. An image or a code example is worth thousand words! + ## Context -Why is this change important to you? How would you use it? How can it benefit other users? + ## Possible Implementation -(Optional) Suggest an idea for implementing the addition or change. + ## Possible Alternatives -(Optional) Describe any alternative solutions or features you've considered. +