chore: Update templates provided to aid in collaboration and following the process (#844)

bryantbiggs · web-flow · commit c775652a1b6e · 2022-08-11T17:55:54.000-04:00
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,55 @@
+---
+name: Bug report
+about: Create a report to help us improve
+---
+
+## Description
+
+Please provide a clear and concise description of the issue you are encountering, and a reproduction of your configuration (see the `examples/*` directory for references that you can copy+paste and tailor to match your configs if you are unable to copy your exact configuration). The reproduction MUST be executable by running `terraform init && terraform apply` without any further changes.
+
+If your request is for a new feature, please use the `Feature request` template.
+
+- [ ] ✋ I have searched the open/closed issues and my issue is not listed.
+
+## ⚠️ Note
+
+Before you submit an issue, please perform the following first:
+
+1. Remove the local `.terraform` directory (! ONLY if state is stored remotely, which hopefully you are following that best practice!): `rm -rf .terraform/`
+2. Re-initialize the project root to pull down modules: `terraform init`
+3. Re-attempt your terraform plan or apply and check if the issue still persists
+
+## Versions
+
+- Module version [Required]:
+
+- Terraform version:
+<!-- Execute terraform -version -->
+- Provider version(s):
+<!-- Execute: terraform providers -version -->
+
+## Reproduction Code [Required]
+
+<!-- REQUIRED -->
+
+Steps to reproduce the behavior:
+
+<!-- Are you using workspaces? -->
+<!-- Have you cleared the local cache (see Notice section above)? -->
+<!-- List steps in order that led up to the issue you encountered -->
+
+## Expected behavior
+
+<!-- A clear and concise description of what you expected to happen -->
+
+## Actual behavior
+
+<!-- A clear and concise description of what actually happened -->
+
+### Terminal Output Screenshot(s)
+
+<!-- Optional but helpful -->
+
+## Additional context
+
+<!-- Add any other context about the problem here -->
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,23 +1,30 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: '[FEATURE] <title>'
-labels: 'feature-request'
-assignees: ''
-
 ---
 
-#### Is your feature request related to a problem? Please describe
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+<!--- Please keep this note for the community --->
+
+### Community Note
+
+* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
+* Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
+* If you are interested in working on this issue or have submitted a pull request, please leave a comment
 
+<!--- Thank you for keeping this note for the community --->
 
-#### Describe the solution you'd like
-A clear and concise description of what you want to happen.
+#### What is the outcome that you are trying to reach?
 
+<!-- A clear and concise description of what the problem is. -->
 
-#### Describe alternatives you've considered
-A clear and concise description of any alternative solutions or features you've considered.
+#### Describe the solution you would like
 
+<!-- A clear and concise description of what you want to happen. -->
+
+#### Describe alternatives you have considered
+
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
 
 #### Additional context
-Add any other context or screenshots about the feature request here.
+
+<!-- Add any other context or screenshots about the feature request here. -->
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
@@ -1,24 +1,18 @@
 ---
 name: Question
 about: I have a Question
-title: '[QUESTION] <title>'
-labels: 'question'
-assignees: ''
-
 ---
 
+- [ ] ✋ I have searched the open/closed issues and my issue is not listed.
+
 #### Please describe your question here
+
 <!-- Provide as much information as possible to explain your question -->
 
+#### Provide a link to the example/module related to the question
 
-#### Provide link to the example related to the question
 <!-- Please provide the link to the example related to this question from this repo -->
 
-
 #### Additional context
-<!-- Add any other context or screenshots about the question here -->
-
 
-#### More
-
-- [ ] Yes, I have checked the repo for existing issues before raising this question
+<!-- Add any other context or screenshots about the question here -->
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,26 +1,26 @@
-
 ### What does this PR do?
 
-<!-- A brief description of the change being made with this pull request. -->
+🛑 Please open an issue first to discuss any significant work and flesh out details/direction - we would hate for your time to be wasted.
+Consult the [CONTRIBUTING](https://github.com/aws-ia/terraform-aws-eks-blueprints/blob/main/CONTRIBUTING.md#contributing-via-pull-requests) guide for submitting pull-requests.
 
+<!-- A brief description of the change being made with this pull request. -->
 
 ### Motivation
 
 <!-- What inspired you to submit this pull request? -->
 
-
 ### More
 
-- [ ] Yes, I have tested the PR using my local account setup  (Provide any test evidence report under Additional Notes)
+- [ ] Yes, I have tested the PR using my local account setup (Provide any test evidence report under Additional Notes)
 - [ ] Yes, I have added a new example under [examples](https://github.com/aws-ia/terraform-aws-eks-blueprints/tree/main/examples) to support my PR
 - [ ] Yes, I have created another PR for add-ons under [add-ons](https://github.com/aws-samples/eks-blueprints-add-ons) repo (if applicable)
 - [ ] Yes, I have updated the [docs](https://github.com/aws-ia/terraform-aws-eks-blueprints/tree/main/docs) for this feature
 - [ ] Yes, I ran `pre-commit run -a` with this PR
 
-
 **Note**: Not all the PRs required examples and docs except a new pattern or add-on added.
 
 ### For Moderators
+
 - [ ] E2E Test successfully complete before merge?
 
 ### Additional Notes
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -6,24 +6,23 @@ documentation, we greatly value feedback and contributions from our community.
 Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
 information to effectively respond to your bug report or contribution.
 
-
 ## Reporting Bugs/Feature Requests
 
 We welcome you to use the GitHub issue tracker to report bugs or suggest features.
 
 When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
 reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
 
-* A reproducible test case or series of steps
-* The version of our code being used
-* Any modifications you've made relevant to the bug
-* Anything unusual about your environment or deployment
-
+- A reproducible test case or series of steps
+- The version of our code being used
+- Any modifications you've made relevant to the bug
+- Anything unusual about your environment or deployment
 
 ## Contributing via Pull Requests
+
 Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
 
-1. You are working against the latest source on the *main* branch.
+1. You are working against the latest source on the _main_ branch.
 2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
 3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
 
@@ -39,20 +38,19 @@ To send us a pull request, please:
 GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
 [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
 
-
 ## Finding contributions to work on
-Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
 
+Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
 
 ## Code of Conduct
+
 This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
 For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
 opensource-codeofconduct@amazon.com with any additional questions or comments.
 
-
 ## Security issue notifications
-If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
 
+If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
 
 ## Licensing
 
