Improve issue template (kedro-org#2707)

* Typo Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> * Hide placeholders in issue template Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> --------- Signed-off-by: Juan Luis Cano Rodríguez <[email protected]> Signed-off-by: Juan Lovera <[email protected]>
jmalovera10 · Jun 30, 2023 · 864ce0e · 864ce0e
1 parent fd0c937
commit 864ce0e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -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.
@@ -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`):

diff --git a/kedro/templates/project/{{ cookiecutter.repo_name }}/README.md b/kedro/templates/project/{{ cookiecutter.repo_name }}/README.md
@@ -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.