From b77b78ca8da7afa35e98f3753d2939ef79e49bc1 Mon Sep 17 00:00:00 2001 From: Khosrow Moossavi Date: Tue, 2 Feb 2021 15:46:44 -0500 Subject: [PATCH] Improve pull request template Signed-off-by: Khosrow Moossavi --- .github/PULL_REQUEST_TEMPLATE.md | 51 +++++++++++++++----------------- 1 file changed, 24 insertions(+), 27 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 53ec3f7..cab6c4a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,38 +1,35 @@ -### Prerequisites + -- [ ] This pull request fixes a bug. -- [ ] This pull request adds a feature. -- [ ] This pull request enhances existing functionality. -- [ ] This pull request introduces breaking change. +### Description of your changes -For more information, see the [Contributing Guide](https://github.com/terraform-docs/terraform-docs/tree/master/CONTRIBUTING.md). + -Describe what this pull request achieves. Ensure you have read the [Contributing Guidelines](https://github.com/terraform-docs/terraform-docs/tree/master/CONTRIBUTING.md) document before submitting. + -### Issues Resolved +I have: -List any existing issues this pull request resolves. - -### Checklist - -Put an `x` into all boxes that apply: - -- [ ] I have read the [Contributing Guidelines](https://github.com/terraform-docs/terraform-docs/tree/master/CONTRIBUTING.md). - -#### Tests - -- [ ] I have added tests to cover my changes. +- [ ] Read and followed terraform-docs' [contribution process]. - [ ] All tests pass when I run `make test`. -#### Documentation +### How has this code been tested -- [ ] My change requires a change to the documentation. -- [ ] I have updated the documentation accordingly. + -#### Code Style - -- [ ] My code follows the code style of this project. +[contribution process]: https://git.io/JtEzg