Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve issue template #2707

Merged
merged 2 commits into from
Jun 21, 2023
Merged

Improve issue template #2707

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4b25c5
Typo
astrojuanlu May 8, 2023
dfdfddf
Hide placeholders in issue template
astrojuanlu Jun 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions .github/ISSUE_TEMPLATE/bug-report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@ assignees: ''
---

## 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
1. [First Step]
<!-- 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 @@ -33,7 +33,7 @@ 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 version used (`pip show kedro` or `kedro -V`):
* Python version used (`python -V`):
Expand Down
2 changes: 1 addition & 1 deletion kedro/templates/project/{{ cookiecutter.repo_name }}/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

This is your new Kedro project, which was generated using `Kedro {{ cookiecutter.kedro_version }}`.
This is your new Kedro project, which was generated using `kedro {{ cookiecutter.kedro_version }}`.

Take a look at the [Kedro documentation](https://docs.kedro.org) to get started.

Expand Down