From 0c71b6d95f6de96211bf81122fb6b3c745079f94 Mon Sep 17 00:00:00 2001
From: Luca Filipozzi <luca.filipozzi@gmail.com>
Date: Mon, 23 Aug 2021 10:02:38 -0700
Subject: [PATCH] improve documentation

---
 .github/ISSUE_TEMPLATE/bug_report.md | 35 +++++++++-------------------
 SECURITY.md                          |  2 +-
 2 files changed, 12 insertions(+), 25 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index dd84ea7..8d1bd2e 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,5 +1,5 @@
 ---
-name: Bug report
+name: Bug Report
 about: Create a report to help us improve
 title: ''
 labels: ''
@@ -7,32 +7,19 @@ assignees: ''
 
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+### Describe the Bug
 
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+Please provide a description of the bug.
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+### Steps To Reproduce
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+Please provide the steps to reproduce the bug.
 
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+### Expected Behavior
 
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+Please provide a description of the expected behaviour.
 
-**Additional context**
-Add any other context about the problem here.
+### Environment
+
+Please provide details of your environment (e.g.: keycloak version, java version. operating system
+and version, etc.).
diff --git a/SECURITY.md b/SECURITY.md
index a878dad..294afc1 100644
--- a/SECURITY.md
+++ b/SECURITY.md
@@ -1,6 +1,6 @@
 # Security Policy
 
-This project is provided on a 'time-avaialble' basis.
+This project is provided on a 'time-available' basis.
 
 If you have a security concern to report, please open an issue or a pull request.