From a13c050e9dd15d998f4ad1c3f3257fd79f143dc7 Mon Sep 17 00:00:00 2001
From: Eric Dantas <ericrommel@gmail.com>
Date: Mon, 10 Jul 2023 16:17:52 +0200
Subject: [PATCH] chore: Improve info that should be filled out for bugs and
 features (#9978)

Co-authored-by: Peer Richelsen <peeroke@gmail.com>
---
 .github/ISSUE_TEMPLATE/bug_report.md      | 18 +++++++++++++---
 .github/ISSUE_TEMPLATE/feature_request.md |  8 +++++++
 .github/PULL_REQUEST_TEMPLATE.md          | 26 +++++++++++++++--------
 3 files changed, 40 insertions(+), 12 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 91df8f2eb1..1fcdd70905 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -20,8 +20,20 @@ A summary of the issue. This needs to be a clear detailed-rich summary.
 
 Any other relevant information. For example, why do you consider this a bug and what did you expect to happen instead?
 
+### Actual Results
+
+  - What's happening right now that is different from what is expected
+
+### Expected Results
+
+  - This is an ideal result that the system should get after the tests are performed
+
 ### Technical details
 
-- Browser version, screen recording, console logs, network requests: You can make a recording with [Bird Eats Bug](https://birdeatsbug.com/).
-- Node.js version
-- Anything else that you think could be an issue.
+  - Browser version, screen recording, console logs, network requests: You can make a recording with [Bird Eats Bug](https://birdeatsbug.com/).
+  - Node.js version
+  - Anything else that you think could be an issue.
+
+### Evidence
+
+  - How was this tested? This is quite mandatory in terms of bugs. Providing evidence of your testing with screenshots or/and videos is an amazing way to prove the bug and a troubleshooting chance to find the solution.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 87d2eb23d4..0040d6d364 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -39,3 +39,11 @@ assignees: ""
 -->
 
 (Write your answer here.)
+
+### Requirement/Document
+
+<!--
+  Is there any type of document that could support that feature?
+-->
+
+(Share it here.)
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 1a472b44f0..a4059e40d0 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -8,26 +8,34 @@ Fixes # (issue)
  Loom Video: https://www.loom.com/
 -->
 
+## Requirement/Documentation
+
+<!-- Please provide all documents that are important to understand the reason of that PR. -->
+  - If there is a requirement document, please, share it here.
+  - If there is ab UI/UX design document, please, share it here.
+
 ## Type of change
 
 <!-- Please delete bullets that are not relevant. -->
 
-- Bug fix (non-breaking change which fixes an issue)
-- Chore (refactoring code, technical debt, workflow improvements)
-- New feature (non-breaking change which adds functionality)
-- Breaking change (fix or feature that would cause existing functionality to not work as expected)
-- This change requires a documentation update
+  - [ ] Bug fix (non-breaking change which fixes an issue)
+  - [ ] Chore (refactoring code, technical debt, workflow improvements)
+  - [ ] New feature (non-breaking change which adds functionality)
+  - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+  - [ ] This change requires a documentation update
 
 ## How should this be tested?
 
-<!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration -->
+<!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration. Write details that help to start the tests -->
 
-- [ ] Test A
-- [ ] Test B
+  - Are there environment variables that should be set?
+  - What are the minimal test data to have?
+  - What is expected (happy path) to have (input and output)?
+  - Any other important info that could help to test that PR
 
 ## Mandatory Tasks
 
-- [ ] Make sure you have self-reviewed the code. A decent size PR without self-review might be rejected.
+  - [ ] Make sure you have self-reviewed the code. A decent size PR without self-review might be rejected.
 
 ## Checklist