Skip to content

Commit

Permalink
🚸 Upgrade issue template to avoid polluting issues with advices on ho…
Browse files Browse the repository at this point in the history
…w to fill them (#502)

Signed-off-by: Yolan Honoré-Rougé <yolan.honore.rouge@gmail.com>
  • Loading branch information
Galileo-Galilei committed Dec 19, 2023
1 parent 1387799 commit a37f896
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 16 deletions.
21 changes: 10 additions & 11 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,31 +7,30 @@ assignees: ''

---

**_If you like the repo, please give it a :star:_**
<!-- **_If you like the repo, please give it a :star:_** -->

## Description

Short description of the problem here.
<!-- Short description of the problem here. -->

## Context

How has this bug affected you? What were you trying to accomplish?
<!-- 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.
<!-- 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.
1. [First Step]
2. [Second Step]
3. [And so on...]
3. [And so on...] -->

## Expected Result

Tell us what should happen.
<!-- Tell us what should happen. -->

## Actual Result

Tell us what happens instead.
<!-- Tell us what happens instead. -->

```
-- If you received an error, place it here.
Expand All @@ -43,20 +42,20 @@ Tell us what happens instead.

## Your Environment

Include as many relevant details about the environment in which you experienced the bug:
<!-- 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`):
* Operating system and version:

## 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.
<!-- 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.
In your environment, please try:
```bash
pip install --upgrade git+https://github.com/Galileo-Galilei/kedro-mlflow
```
And check if you can to reproduce the error. If you can't, just wait for the next release or use the master branch at your own risk!
And check if you can to reproduce the error. If you can't, just wait for the next release or use the master branch at your own risk! -->
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ labels: 'Issue: Feature Request'
assignees: ''
---

*If you like the repo, please give it a :star:*
<!-- **_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!
<!-- 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?
<!-- 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.
<!-- (Optional) Suggest an idea for implementing the addition or change. -->

## Possible Alternatives
(Optional) Describe any alternative solutions or features you've considered.
<!-- (Optional) Describe any alternative solutions or features you've considered. -->

0 comments on commit a37f896

Please sign in to comment.