Skip to content

Commit

Permalink
Use templated YAML files for Github Issues (#875)
Browse files Browse the repository at this point in the history
* Create bug_report.yaml

* Delete bug_report.md

* Replaced markdown files with templated yaml for github issues
  • Loading branch information
hugsy committed Jul 10, 2022
1 parent c530aa5 commit e545378
Show file tree
Hide file tree
Showing 4 changed files with 138 additions and 85 deletions.
64 changes: 0 additions & 64 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

88 changes: 88 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
@@ -0,0 +1,88 @@
name: Bug Report
description: Help us improve GEF by filling up this report correctly.
title: "[Bug] "
body:
- type: markdown
id: md_welcome
attributes:
value: |
Use this form is for reporting bugs GEF! Please provide as much information as possible to allow us
to correctly triage the issue.
- type: textarea
attributes:
label: GEF+GDB version
description: |
The exact version of GEF and GDB. Copy/paste the output of the `version` command.
validations:
required: true
- type: input
id: os_info
attributes:
label: Operating System
description: What OS are you using? Copy/paste the output of `lsb_release -a` or equivalent/
placeholder: "e.g., Arch Linux, FreeBSD"
validations:
required: false
- type: textarea
attributes:
label: Describe the issue you encountered
description: |
Describe the issue in detail and what you were doing beforehand.
validations:
required: true
- type: textarea
attributes:
label: How can the issue be reproduced?
description: |
Include a detailed step by step process for recreating your issue.
1.
2.
validations:
required: true
- type: checkboxes
attributes:
label: Architecture impacted
description: |
On which architecture can you confirm this bug exist?
options:
- label: X86
- label: X64
- label: ARM
- label: ARM64
- label: MIPS
- label: MIPS64
- label: PPC
- label: PPC64
- label: RISCV
- type: textarea
attributes:
label: Describe your issue
value: |
Provide a step-by-step to reproduce your issue.
validations:
required: true
- type: textarea
attributes:
label: Minimalist test case
value: |
Use this field for a minimal code to compile and spot the issue:
```c
// compile with gcc -fPIE -pic -o my_issue.out my_issue.c
int main(){ return 0; }
```
You can also provide a Dockerfile if you prefer
validations:
required: false
- type: textarea
attributes:
label: Additional context?
description: |
If a bug/crash is found, use `gef config gef.debug 1` to enable the debug mode and collect more information.
You can copy/paste those information in the field.
value: |
- Screenshots
- Callstack
- Coredumps
- If possible and useful, please upload the binary
validations:
required: false
21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
@@ -0,0 +1,50 @@
name: Feature Request
description: Use this form to suggest a feature you would like to see in GEF
body:
- type: markdown
id: md_welcome
attributes:
value: |
Had an idea of a new useful feature for GEF, but can't implement it? Here's your chance
- type: dropdown
attributes:
label: Type of feature request
description: Describe the category your feature request falls under
options:
- Additional API
- New architecture support/Existing architecture improvement
- Misc
- type: input
attributes:
label: Misc
description: "If \"Misc\" was selected above, describe the type"
validations:
required: false
- type: textarea
attributes:
label: Summary Description
description: |
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
validations:
required: true
- type: textarea
attributes:
label: Implementation idea/suggestion
description: |
A clear and concise description of how you would like this problem be solved.
validations:
required: true
- type: textarea
attributes:
label: Existing alternatives?
description: |
Describe alternatives already considered.
validations:
required: false
- type: textarea
attributes:
label: Additional information
description: |
Add any other context or screenshots about the feature request here.
validations:
required: false

0 comments on commit e545378

Please sign in to comment.