From 4d2be5678445216ae1a6128af7f697efe617e4e7 Mon Sep 17 00:00:00 2001
From: Rob Morgan <robbym@gmail.com>
Date: Thu, 18 Nov 2021 14:20:58 +0800
Subject: [PATCH] Add GitHub PR & Issue Templates (#63)

---
 .github/ISSUE_TEMPLATE/bug_report.md      | 33 +++++++++++++++++
 .github/ISSUE_TEMPLATE/feature_request.md | 22 ++++++++++++
 .github/pull_request_template.md          | 43 +++++++++++++++++++++++
 3 files changed, 98 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md
 create mode 100644 .github/pull_request_template.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 00000000..d2e87e27
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a bug report to help us improve.
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+<!--
+Have any questions? Check out the contributing docs at https://gruntwork.notion.site/Gruntwork-Coding-Methodology-02fdcd6e4b004e818553684760bf691e,
+or ask in this issue and a Gruntwork core maintainer will be happy to help :)
+-->
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior including the relevant Terraform/Terragrunt/Packer version number and any code snippets and module inputs you used.
+
+```hcl
+// paste code snippets here
+```
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Nice to have**
+- [ ] Terminal output
+- [ ] Screenshots
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 00000000..023a3309
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,22 @@
+---
+name: Feature request
+about: Submit a feature request for this repo.
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+<!--
+Have any questions? Check out the contributing docs at https://gruntwork.notion.site/Gruntwork-Coding-Methodology-02fdcd6e4b004e818553684760bf691e,
+or ask in this issue and a Gruntwork core maintainer will be happy to help :)
+-->
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've 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.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 00000000..1ed18dac
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,43 @@
+<!--
+Have any questions? Check out the contributing docs at https://gruntwork.notion.site/Gruntwork-Coding-Methodology-02fdcd6e4b004e818553684760bf691e,
+or ask in this Pull Request and a Gruntwork core maintainer will be happy to help :)
+Note: Remember to add '[WIP]' to the beginning of the title if this PR is still a work-in-progress. Remove it when it is ready for review!
+-->
+
+## Description
+
+<!-- Write a brief description of the changes introduced by this PR -->
+
+### Documentation
+
+<!--
+  If this is a feature PR, then where is it documented?
+
+  - If docs exist:
+    - Update any references, if relevant.
+  - If no docs exist:
+    - Create a stub for documentation including bullet points for how to use the feature, code snippets (including from happy path tests), etc.
+-->
+
+<!-- Important: Did you make any backward incompatible changes? If yes, then you must write a migration guide! -->
+
+## TODOs
+
+Please ensure all of these TODOs are completed before asking for a review.
+
+- [ ] Ensure the branch is named correctly with the issue number. e.g: `feature/new-vpc-endpoints-955` or `bug/missing-count-param-434`.
+- [ ] Update the docs.
+- [ ] Keep the changes backward compatible where possible.
+- [ ] Run the pre-commit checks successfully.
+- [ ] Run the relevant tests successfully.
+- [ ] Ensure any 3rd party code adheres with our [license policy](https://www.notion.so/gruntwork/Gruntwork-licenses-and-open-source-usage-policy-f7dece1f780341c7b69c1763f22b1378) or delete this line if its not applicable.
+
+
+## Related Issues
+
+<!--
+  Link to related issues, and issues fixed or partially addressed by this PR.
+  e.g. Fixes #1234
+  e.g. Addresses #1234
+  e.g. Related to #1234
+-->