diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..3c056088 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,38 @@ + + +##### ISSUE TYPE + - [ ] Bug Report + - [ ] Feature Idea + +# BUG REPORT + +##### SUMMARY + + +##### ENVIRONMENT +* Kubeaudit version: X.Y.Z +* Kubeaudit install method: DIY-BUILD/Binary/Kubectl-Plugin + +##### STEPS TO REPRODUCE + + + +##### EXPECTED RESULTS + + + +##### ACTUAL RESULTS + + + +##### ADDITIONAL INFORMATION + + + +# FEATURE IDEA + +- [ ] If the maintainers agree with the feature as described here, I intend to submit a Pull Request myself.1 + +**Proposal:** + +1 This is the quickest way to get a new feature! We reserve the right to close feature requests, even ones we like, if the proposer does not intend to contribute to the feature and it doesn't fit in our current roadmap. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..8897206f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,32 @@ + + + + +##### Description + + + +Fixes # (issue) + +##### Type of change + + +- [ ] Bug fix :bug: +- [ ] New feature :sparkles: +- [ ] This change requires a documentation update :book: +- [ ] Breaking changes :warning: +##### How Has This Been Tested? + + + +- [ ] Test A +- [ ] Test B + +##### Checklist: + +- [ ] I have :tophat: my changes (A 🎩 specifically includes pulling down changes, setting them up, and manually testing the changed features and potential side effects to make sure nothing is broken) +- [ ] I have performed a self-review of my own code +- [ ] I have made corresponding changes to the documentation +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes +- [ ] The test coverage did not decrease diff --git a/README.md b/README.md index 38f3af3c..45f3c3f1 100644 --- a/README.md +++ b/README.md @@ -513,6 +513,6 @@ If you'd like to fix a bug, contribute a feature or just correct a typo, please 1. Run the tests to see everything is working as expected: `make test` 1. Commit your changes: `git commit -am 'Adds awesome feature'` 1. Push to the branch: `git push fork` -1. Submit a PR +1. Submit a PR (All PR must be labeled with :bug: (Bug fix), :sparkles: (New feature), :book: (Documentation update), or :warning: (Breaking changes) ) 1. ??? 1. Profit