Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(templates): Improve bug template with more info #982

Merged
merged 1 commit into from
Jan 4, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 24 additions & 9 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,49 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
title: "[Bug]: "
labels: ["bug", "triage"]
assignees: ''

---

**Describe the bug**
<!--
Please use this template to create your bug report. By providing as much info as possible you help us understand the issue, reproduce it and resolve it for you quicker. Therefore, take a couple of extra minutes to make sure you have provided all info needed.

PROTIP: record your screen and attach it as a gif to showcase the issue.

- How to record and attach gif: https://bit.ly/2Mi8T6K
-->

**What happened?**
A clear and concise description of what the bug is or what is not working as expected

**To Reproduce**

**How to reproduce it**
Steps to reproduce the behavior:
1. Command you are running
1. What command are you running?
2. Environment you have, like single account, multi-account, organizations, etc.
3. See error

**Expected behavior**

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots or Logs**

**Screenshots or Logs**
If applicable, add screenshots to help explain your problem.
Add logs (anonymize them first!). Here a command that may help to share a log
Also, you can add logs (anonymize them first!). Here a command that may help to share a log
`bash -x ./prowler -options > debug.log 2>&1` then attach here `debug.log`

**From where are you running Prowler? (please complete the following information):**

**From where are you running Prowler?**
Please, complete the following information:
- Resource: [e.g. EC2 instance, Fargate task, Docker container manually, EKS, Cloud9, CodeBuild, workstation, etc.)
- OS: [e.g. Amazon Linux 2, Mac, Alpine, Windows, etc. ]
- AWS-CLI Version [`aws --version`]:
- Prowler Version [`./prowler -V`]:
- Shell and version:
- Others:


**Additional context**
Expand Down