Magic-Mirror/radare2
1
0
Fork 0
mirror of https://github.com/radareorg/radare2.git synced 2024-11-23 13:19:54 +00:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity

Simplify github issue/pr templates (#18009)

Browse Source
This commit is contained in:
pancake 2020-12-08 23:51:17 +01:00 committed by GitHub
parent c2311d0a96
commit 3bff6182ac
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 27 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
.github/ISSUE_TEMPLATE/bug_report.md vendored
View File

@ -4,31 +4,19 @@ about: Create a report to help us improve
---
# This template is meant for bug reports, if you have a feature request, please be as descriptive as possible and delete the template
## Environment
Make sure you are testing using the latest git version of radare2 before submitting any issue.
```sh
# copypaste this script into your shell and replace it with the output
date
r2 -v
uname -ms
```
*If you would like to report a bug, please fill the template below*
## Description
### Work environment
<!-- Explain what's the issue and what would you expect to see -->
| Questions | Answers
|------------------------------------------------------|--------------------
| OS/arch/bits (mandatory) | Debian arm 64, Ubuntu x86 32
| File format of the file you reverse (mandatory) | PE, ELF etc.
| Architecture/bits of the file (mandatory) | PPC, x86/32, x86/64 etc.
| r2 -v full output, **not truncated** (mandatory) | radare2 2.4.0-git 17284 @ darwin-x86-64 git.2.2.0-476-gf8cf84e06 commit: f8cf84e0653642d9ad34e760e0e56dd81860e799 build: 2018-02-17__11:08:27
## Test
### Expected behavior
### Actual behavior
### Steps to reproduce the behavior
- Please share the binary if it is shareable by drag and dropping it here in a zip archive (mandatory)
- Use asciinema to describe the issue and share the link here (mandatory if u can't share the binary)
- Use code markdown `CODE` to make your code visible
- Or even better, create a Pull-Request containing the test case in the test/ folder. See for example test/new/db/cmd/cmd_search.
### Additional Logs, screenshots, source-code, configuration dump, ...
Drag and drop zip archives containing the Additional info here, don't use external services or link.
<!-- Steps to reproduce the issue and provide files/links/images/.. -->

13
.github/ISSUE_TEMPLATE/feature_request.md vendored
View File

@ -4,15 +4,8 @@ about: Suggest an idea for this project
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
## Description
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
For UI requests, don't hesitate to post some draws.
*Please describe what are you missing or wanting to be improved*
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.
*Provide images, ascii-art, test files and anything that may help us understand your request*

34
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -1,25 +1,17 @@
<!-- Filling this template is mandatory -->
<!-- Please read the contributing guidelines:
* https://github.com/radareorg/radare2/blob/master/DEVELOPERS.md
In short:
* PR title must be capitalized, concise and use ##tags
* Follow the coding style, add tests and documentation if necessary
-->
**Your checklist for this pull request**
- [ ] I've read the [guidelines for contributing](https://github.com/radareorg/radare2/blob/master/DEVELOPERS.md) to this repository
- [ ] I made sure to follow the project's [coding style](https://github.com/radareorg/radare2/blob/master/DEVELOPERS.md#code-style)
- [ ] I've added tests that prove my fix is effective or that my feature works (if possible)
- [ ] I've updated the documentation and the [radare2 book](https://github.com/radareorg/radare2book) with the relevant information (if needed)
**Checklist**
**Detailed description**
- [ ] Closing issues: #issue
- [ ] Mark this if you consider it ready to merge
- [ ] I've added tests (optional)
- [ ] I wrote some lines in the [radare2book](https://github.com/radareorg/radare2book)
<!-- 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. -->
**Description**
...
**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). -->
...
<!-- Explain the **details** to understand the purpose of this contribution, with enough information to help us understand better the changes. -->