From 604c2b452e71821d2e8461c0bfb4e1214eae7ed0 Mon Sep 17 00:00:00 2001
From: Philipp Muens <raute1337@gmx.de>
Date: Wed, 25 Sep 2019 14:57:54 +0200
Subject: [PATCH] Simplify GitHub Issue / PR templates

---
 .github/ISSUE_TEMPLATE/bug_report.md      | 32 +++++--------
 .github/ISSUE_TEMPLATE/feature_request.md | 20 +++------
 .github/PULL_REQUEST_TEMPLATE.md          | 55 +++++++----------------
 3 files changed, 32 insertions(+), 75 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 7dc59f594..33fa41b1a 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,33 +1,21 @@
 ---
 name: Bug report
-about: Create a report to help us improve
+about: Create a bug report
 ---
 
-<!--
-1. If you have a question and not a bug report please ask first at http://forum.serverless.com
-2. Please check if an issue already exists. This bug may have already been documented
-3. Check out and follow our Guidelines: https://github.com/serverless/serverless/blob/master/CONTRIBUTING.md
-4. Fill out the whole template so we have a good overview on the issue
-5. Do not remove any section of the template. If something is not applicable leave it empty but leave it in the Issue
-6. Please follow the template, otherwise we'll have to ask you to update it
--->
-
-# This is a Bug Report
+# Bug Report
 
 ## Description
 
-- What went wrong?
-- What did you expect should have happened?
-- What was the config you used?
-- What stacktrace or error message from your provider did you see?
+<!-- Please use https://forum.serverless.com, StackOverflow or other forums for Q&A -->
+<!-- Please answer ALL the question below. Otherwise we probably have to close the issue due to missing information -->
+
+1. What did you do?
+1. What happened?
+1. What should've happened?
+1. What's the content of your `serverless.yml` file?
+1. What's the output you get when you use the `SLS_DEBUG=*` environment variable (e.g. `SLS_DEBUG=* serverless deploy`)
 
 Similar or dependent issues:
 
 - #12345
-
-## Additional Data
-
-- **_Serverless Framework Version you're using_**:
-- **_Operating System_**:
-- **_Stack Trace_**:
-- **_Provider Error messages_**:
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 5c520999f..787ed3c27 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,23 +1,17 @@
 ---
 name: Feature request
-about: Suggest an idea for serverless framework
+about: Suggest an idea
 ---
 
-<!--
-1. If you have a question and not a feature request please ask first at http://forum.serverless.com
-2. Please check if an issue already exists. This feature may have already been requested
-3. Check out and follow our Guidelines: https://github.com/serverless/serverless/blob/master/CONTRIBUTING.md
-4. Fill out the whole template so we have a good overview on the issue
-5. Do not remove any section of the template. If something is not applicable leave it empty but leave it in the Issue
-6. Please follow the template, otherwise we'll have to ask you to update it
--->
-
-# This is a Feature Proposal
+# Feature Proposal
 
 ## Description
 
-- What is the use case that should be solved. The more detail you describe this in the easier it is to understand for us.
-- If there is additional config how would it look
+<!-- Please use https://forum.serverless.com, StackOverflow or other forums for Q&A -->
+<!-- Please answer ALL the question below. Otherwise we probably have to close the issue due to missing information -->
+
+1. What is the use case that should be solved. The more detail you describe this in the easier it is to understand for us.
+1. **Optional:** If there is additional config how would it look
 
 Similar or dependent issues:
 
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 4d9bf3c49..856438efc 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,54 +1,29 @@
-<!--
-1. Please check out and follow our Contributing Guidelines: https://github.com/serverless/serverless/blob/master/CONTRIBUTING.md
-2. Do not remove any section of the template. If something is not applicable leave it empty but leave it in the PR
-3. Please follow the template, otherwise we'll have to ask you to update it and it will take longer until your PR is merged
--->
+<!-- Please fill out THE WHOLE PR TEMPLATE. Otherwise we probably have to close the PR due to missing information -->
 
-## What did you implement:
+## What did you implement
+
+<!-- Briefly describe the scope of your PR -->
 
 Closes #XXXXX
 
-<!--
-Briefly describe the feature if no issue exists for this PR
--->
+## How can we verify it
 
-## How did you implement it:
+<!-- A copy-and-pasteable `serverless.yml` file with optional steps to verify the implementation -->
 
-<!--
-If this is a nontrivial change please briefly describe your implementation so its easy for us to understand and review your code.
--->
+## Todos
 
-## How can we verify it:
+**Useful scripts:**
 
-<!--
-Add any applicable config, commands, screenshots or other resources
-to make it easy for us to verify this works. The easier you make it for us
-to review a PR, the faster we can review and merge it.
+- `npm run test-ci` --> Run all validation checks on proposed changes
+- `npm run lint-updated` --> Lint all the updated files
+- `npm run lint:fix` --> Automatically fix lint problems (if possible)
+- `npm run prettier-check-updated` --> Check if updated files adhere to Prettier config
+- `npm run prettify-updated` --> Prettify all the updated files
 
-Examples:
-* serverless.yml - Fully functioning to easily deploy changes
-* Screenshots - Showing the difference between your output and the master
-* Cloud Configuration - List cloud resources and show that the correct configuration is in place (e.g. AWS CLI commands)
-* Other - Anything else that comes to mind to help us evaluate
--->
-
-## Todos:
-
-_**Note: Run `npm run test-ci` to run all validation checks on proposed changes**_
-
-- [ ] Write tests and confirm existing functionality is not broken.  
-       **Validate via `npm test`**
+- [ ] Write and run all tests
 - [ ] Write documentation
-- [ ] Ensure there are no lint errors.  
-       **Validate via `npm run lint-updated`**  
-       _Note: Some reported issues can be automatically fixed by running `npm run lint:fix`_
-- [ ] Ensure introduced changes match Prettier formatting.  
-       **Validate via `npm run prettier-check-updated`**  
-       _Note: All reported issues can be automatically fixed by running `npm run prettify-updated`_
-- [ ] Make sure code coverage hasn't dropped
-- [ ] Provide verification config / commands / resources
 - [ ] Enable "Allow edits from maintainers" for this PR
 - [ ] Update the messages below
 
-**_Is this ready for review?:_** NO  
+**_Is this ready for review?:_** NO
 **_Is it a breaking change?:_** NO