From 7312bbe47c1054ad04c5f9761ac59deba4def5e0 Mon Sep 17 00:00:00 2001 From: Shay Nehmad Date: Thu, 14 Nov 2019 18:54:48 +0200 Subject: [PATCH] Updated the issue templates to look a bit nicer. --- .github/ISSUE_TEMPLATE/Bug_report.md | 16 +++++++++++----- .github/ISSUE_TEMPLATE/Feature_request.md | 20 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 11 +++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 17 ++++++++++------- 4 files changed, 52 insertions(+), 12 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/Feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md index 36fcff7c3..f576fabf9 100644 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -4,20 +4,26 @@ about: Create a report to help us fix things! --- -**Describe the bug** + + +## Describe the bug A clear and concise description of what the bug is. -**To Reproduce** +## To Reproduce Steps to reproduce the behavior: 1. Configure the Monkey with X settings 2. Run the monkey on specific machine 3. See error -**Expected behavior** +## Expected behavior A description of what you expected to happen. -**Screenshots** +## Screenshots If applicable, add screenshots to help explain your problem. -**Machine version(please complete the following information):** +## Machine version (please complete the following information): - OS: Windows or Linux diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md new file mode 100644 index 000000000..a59c5f624 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -0,0 +1,20 @@ +--- +name: "\U0001F680 Feature request" +about: Suggest an idea for this project + +--- + + + +**Is your feature request related to a problem? Please describe.** +Please describe the problem you are trying to solve. + +**Describe the solution you'd like** +Please describe the desired behavior. + +**Describe alternatives you've considered** +Please describe alternative solutions or features you have considered. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..a9312fe43 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: false +contact_links: + - name: Slack Channel + url: https://join.slack.com/t/infectionmonkey/shared_invite/enQtNDU5MjAxMjg1MjU1LWM0NjVmNWE2ZTMzYzAxOWJiYmMxMzU0NWU3NmUxYjcyNjk0YWY2MDkwODk4NGMyNDU4NzA4MDljOWNmZWViNDU + about: Out community Slack channel - you can ask questions or suggest things here. + - name: Support Email + url: support@infectionMonkey.com + about: Support E-mail to contact us in a private manner. + - name: FAQs + url: https://www.guardicore.com/infectionmonkey/faq/ + about: Frequently Asked Questions - if you have a question, see if we've already answered it! \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 00c0f3c86..ebee094c8 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,12 +1,15 @@ -# Feature / Fixes -> Changes/Fixes the following feature +# What is this? +Fixes #`put issue number here`. +Add any further explanations here. + +## Checklist * [ ] Have you added an explanation of what your changes do and why you'd like to include them? * [ ] Have you successfully tested your changes locally? +* [ ] Is the TravisCI build passing? -* Example screenshot/log transcript of the feature working +## Proof that it works +If applicable, add screenshots or log transcripts of the feature working -## Changes - - - - - - +## Changes +Are the commit messages enough? If not, elaborate.