diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a75ea8a..1c0697f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,21 +1,36 @@ -## Description (*) - -## Fixed Issues (if necessary) - -## Screenshots (if necessary) - -## Contribution checklist (*) - - [ ] I have read the Contributing Guidelines - - [ ] Commits have been made with meaningful commit messages - - [ ] All automated tests have passed successfully +## Description +Please include a summary of the change and which issue is fixed. Also include relevant motivation and context. List any dependencies that are required for this change. + +## Contribution Guidelines +Please Read through the [Contribution Guidelines](https://github.com/aquasecurity/kube-hunter/blob/master/CONTRIBUTING.md). + +## Fixed Issues + +Please mention any issues fixed in the PR by referencing it properly in the commit message. +As per the convention, use appropriate keywords such as `fixes`, `closes`, `resolves` to automatically refer the issue. +Please consult [official github documentation](https://help.github.com/en/github/managing-your-work-on-github/closing-issues-using-keywords) for details. + +Fixes #(issue) + +## "BEFORE" and "AFTER" output + +To verify that the change works as desired, please include an output of terminal before and after the changes under headings "BEFORE" and "AFTER". + +### BEFORE +Any Terminal Output Before Changes. + +### AFTER +Any Terminal Output Before Changes. + +## Contribution checklist + - [ ] I have read the Contributing Guidelines. + - [ ] The commits refer to an active issue in the repository. + - [ ] I have added automated testing to cover this case. + +## Notes +Please mention if you have not checked any of the above boxes.