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

Add issue and PR templates #2294

Merged
merged 2 commits into from
Mar 20, 2024
Merged
Show file tree
Hide file tree
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
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report_asm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
name: Bug report - Incorrect disassembly
about: Create a report about incorrect disassembly.
---

<!-- This template is meant for disassembly related bug reports, please be as descriptive as possible -->

### Work environment

<!-- Filling this table is mandatory -->

| Questions | Answers
|------------------------------------------|--------------------
| OS/arch/bits | Debian arm 64, MacOS AArch64, MacOS x86, Windows x86 etc.
| Architecture | ppc, x86, cortexm, armv8 etc.
| Source of Capstone | `git clone`, brew, pip, release binaries etc.
| Version/git commit | v5.0.1, <commit hash>

<!-- INCORRECT DISASSEMBLY BUGS -->

### Instruction bytes giving faulty results

```
0x00,0x00,0x00,0x00
```

### Expected results

It should be:
```
<this or that>
```

### Steps to get the wrong result

With `cstool`:

```sh
cstool arm -d 0x00,0x00,0x00,0x00
```

or with `Python`

```python
CODE = b'\x90\x90\x90\x90'

md = Cs(CS_ARCH_ARM, CS_MODE_THUMB)
md.detail = True
for insn in md.disasm(CODE, 0x1000):
# Print the faulty disassembly
```

<!-- ADDITIONAL CONTEXT -->

### Additional Logs, screenshots, source code, configuration dump, ...

Drag and drop zip archives containing the Additional info here, don't use external services or link.
Screenshots can be directly dropped here.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report_general.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: Bug report - Other bugs
about: Create a report to help us improve

---

<!-- This template is meant for GENERAL bug reports.
For bugs regarding incorrect disassembly,
please use the "Bug report - Incorrect disassembly" template.

Please be as descriptive as possible
-->

### Work environment

<!-- Filling this table is mandatory -->

| Questions | Answers
|------------------------------------------|--------------------
| OS/arch/bits | Debian arm 64, MacOS AArch64, MacOS x86, Windows x86 etc.
| Architecture | ppc, x86, cortexm, armv8 etc.
| Source of Capstone | `git clone`, brew, pip, release binaries etc.
| Version/git commit | v5.0.1, <commit hash>

<!-- OTHER BUGS -->

### Expected behavior

### Actual behavior

### Steps to reproduce the behavior

- Use code markdown `CODE` to make your code visible

<!-- ADDITIONAL CONTEXT -->

### Additional Logs, screenshots, source code, configuration dump, ...

Drag and drop zip archives containing the Additional info here, don't use external services or link.
Screenshots can be directly dropped here.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Feature request
about: Suggest an idea for this project

---

### Feature

- [ ] New architecture module
- [ ] Support for processor extension
- [ ] Add more instruction details (elaborated below)
- [ ] Binding support for: `language`
- [ ] Other (elaborated below)

**Describe the feature you'd like**
A clear and concise description of what you want to happen.

**Additional context**
Add any other context about the feature request here.
23 changes: 23 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!-- Filling this template is mandatory -->

**Your checklist for this pull request**
- [ ] I've documented or updated the documentation of every function and struct this PR changes. If not so I've explained why.
- [ ] I've added tests that prove my fix is effective or that my feature works (if possible)

**Detailed description**

<!-- Explain the **details** for making this change. Is a new feature implemented? What existing problem does the pull request solve? How does the pull request solve these issues? Please provide enough information so that others can review your pull request. -->

...

**Test plan**

<!-- What steps should the reviewer take to test your pull request? Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots/videos. This is your time to re-check that everything works and that you covered all the edge cases -->

...

**Closing issues**

<!-- put "closes #XXXX" in your comment to auto-close the issue that your PR fixes (if any). -->

...
Loading