aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRot127 <45763064+Rot127@users.noreply.github.com>2024-03-20 08:57:52 +0000
committerGitHub <noreply@github.com>2024-03-20 16:57:52 +0800
commit3ef564bcf40920a37ce7ad414d4ccc26bb5f7fa1 (patch)
tree8a781fd419f481bd6eb7b423570de9263a8ceddf
parentb4fde983de9d14c038afef88e79fe1111388e569 (diff)
downloadcapstone-3ef564bcf40920a37ce7ad414d4ccc26bb5f7fa1.tar.gz
Add issue and PR templates (#2294)
* Add PR template. * Add issue templates.
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report_asm.md58
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report_general.md40
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md19
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md23
4 files changed, 140 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report_asm.md b/.github/ISSUE_TEMPLATE/bug_report_asm.md
new file mode 100644
index 00000000..1042bb73
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report_asm.md
@@ -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.
diff --git a/.github/ISSUE_TEMPLATE/bug_report_general.md b/.github/ISSUE_TEMPLATE/bug_report_general.md
new file mode 100644
index 00000000..b14585f5
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report_general.md
@@ -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. \ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 00000000..77e3e33f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -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.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000..40deda3e
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -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). -->
+
+...