diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..2f318c0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,45 @@ +--- +name: Create a bug report +about: Describe your issue and help us improve Binary Ninja debugger +title: '' +labels: '' +assignees: '' + +--- + +**Version and Platform (required):** +- Binary Ninja Version: [e.g. 4.0.4000-dev] (if version is stable, please also test the latest development build via the "Update Channel" option) +- OS: [e.g. Ubuntu Linux] +- OS Version: [e.g. 22.04] +- CPU Architecture: [e.g. x64 or M1] +- Local or Remote Debugging: [e.g, local] + +**Bug Description:** +Please provide a clear and concise description of what happened. + +**Steps To Reproduce:** +Please provide all steps required to reproduce the behavior: +1. Open... +2. Launch it... +3. Interact with it... +4. See error + +**Expected Behavior:** +Please provide a clear and concise description of what you *expected* to happen. + +**Screenshots/Video Recording:** +If applicable, please add screenshots/video recording here to help explain your problem. + +**Binary:** +If applicable, please provide us with the binary to help us work with the issue faster. +This is especially helpful due to the dynamic nature of the debugger. +Here are a few options: + +1. Directly attach it to this issue in a ZIP archive +2. Share a publicly accessible link to it (For malware samples, we do not have access to VirusTotal; [Malshare](https://malshare.com/) is an option) +3. Email it to binaryninja at vector35.com, or join our [slack](https://slack.binary.ninja/) and share with us in private +4. We understand sometimes it is not possible to share the binary -- sure, no worries, we can still work with it! +5. If your issue is general and not related to a specific binary, then there is no need to attach the binary as well + +**Additional Information:** +Please add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..8a0e343 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Binary Ninja Slack + url: https://slack.binary.ninja/ + about: Join for quick responses to short questions + - name: Official Support + url: https://binary.ninja/support/ + about: Check our official support page for more information diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..2503c5c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,17 @@ +--- +name: Request for documentation +about: Let us know where we can clarify Binary Ninja debugger's documentation +title: '' +labels: documentation +assignees: '' + +--- + +**What concept or API needs more documentation?** +Please provide a clear and concise description of the API or concept which is confusing or missing documentation. + +**Is this documentation related to a specific API?** +Describe which API needs documentation: C++, Python. (**Note:** The C API is not intended to be a documented interface.) + +**Are there any known examples of people using this API/concept?** +Describe or link to any public examples for this (i.e., repositories or blog posts). diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..86e76a3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Request a feature +about: Let us know how we could improve Binary Ninja debugger +title: '' +labels: enhancement +assignees: '' + +--- + +**What is the feature you'd like to have?** +Please provide a clear and concise description of what you want. + +**Is your feature request related to a problem?** +If applicable, please provide a clear and concise description of what the problem is. + +**Are any alternative solutions acceptable?** +Please provide a clear and concise description of any alternative solutions or features you've considered. + +**Additional Information:** +Please add any other context or screenshots that would help us understand your feature request here.