From abd1bb8ae0f68a1f2e69e20a4547d3b96c96dd78 Mon Sep 17 00:00:00 2001 From: rocky Date: Sun, 22 Jul 2018 20:18:31 -0400 Subject: [PATCH 1/2] Revise issue templates --- .github/ISSUE_TEMPLATE/analysis-module.md | 35 ++++++++++--- .github/ISSUE_TEMPLATE/bug-report.md | 64 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 28 ---------- .github/ISSUE_TEMPLATE/feature-request.md | 24 +++++++++ 4 files changed, 116 insertions(+), 35 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md diff --git a/.github/ISSUE_TEMPLATE/analysis-module.md b/.github/ISSUE_TEMPLATE/analysis-module.md index 81c8b7e2..63f4d240 100644 --- a/.github/ISSUE_TEMPLATE/analysis-module.md +++ b/.github/ISSUE_TEMPLATE/analysis-module.md @@ -4,13 +4,34 @@ about: Create an analysis module feature request --- -# Detection issue: -Name the issue that should be detected using the analysis module +Please remove any of the optional sections if they are not applicable. -## Description: -Provide a detailed description of the vulnerabiltity that should be detected +## Description -## Link -Provide resources that can help with implementing the analysis module +Replace this text with a description of an vulnerability that should be +detected by a Mythril analysis module. -## Implementation details:Initial implementation ideas/instruction +## Tests + +_This section is optional._ + +Replace this text with suggestions on how to test the feature, +if it is not obvious. This might require certain Solidity source, +bytecode, or a Truffle project. You can also provide +links to existing code. + +## Implementation details + +_This section is optional._ + +If you have thoughts about how to implement the analysis, feel free +replace this text with that. + +## Links + +_This section is optional._ + +Replace this text with any links describing the issue or pointing to resources +that can help in implementing the analysis + +Thanks for helping! diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 00000000..3df77cd0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,64 @@ +--- +name: Bug report +about: Tell us about Mythril bugs to help us improve + +--- + +_Note: did you notice that there is now a template for requesting new features?_ + +Please remove any of the optional sections if they are not applicable. + +## Description + +Replace this text with a clear and concise description of the bug. + +## How to Reproduce + +Please show both the input you gave and the +output you got in describing how to reproduce the bug: + +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +or give a complete console log with input and output + +```console +$ myth +==== Exception state ==== +Type: ... +Contract: ... +Function name: ... +... +$ +``` + +## Expected behavior + +A clear and concise description of what you expected to happen. + +## Screenshots + +_This section is optional._ + +If applicable, add screenshots to help explain your problem. + +## Environment + +_This section sometimes is optional but helpful to us._ + +Please modify for your setup + +- OS: [e.g. iOS] +- OS Version [e.g. 22] +- Mythril version: output from `myth --version` or `pip show mythril` +- Solidity compiler and version: `solc --version` + +## Additional Environment or Context + +_This section is optional._ + +Add any other context about the problem here or special environment setup + +Thanks for helping! diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 0c898ce3..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 00000000..b06ae9a4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,24 @@ +--- +name: Feature Request +about: Tell us about a new feature that would make Mythril better + +--- + +## Description + +Replace this text with a short description of the feature. + +## Background + +Replace this text with any additional background for the +feature, for example: user scenarios, or the value of the feature. + +## Tests +_This section is optional._ + +Replace this text with suggestions on how to test the feature, +if it is not obvious. This might require certain Solidity source, +bytecode, or a Truffle project. You can also provide +links to existing code. + +Thanks for helping! From 1408b8b9209643972d89a07bd77b00f53e864823 Mon Sep 17 00:00:00 2001 From: rocky Date: Tue, 24 Jul 2018 21:55:37 -0400 Subject: [PATCH 2/2] Include Python version on bug report. --- .github/ISSUE_TEMPLATE/bug-report.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 3df77cd0..aa33c0e9 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -34,6 +34,9 @@ Function name: ... $ ``` +If there is a Solidity source code, a truffle project, or bytecode +that is involved, please provide that or links to it. + ## Expected behavior A clear and concise description of what you expected to happen. @@ -50,10 +53,11 @@ _This section sometimes is optional but helpful to us._ Please modify for your setup -- OS: [e.g. iOS] -- OS Version [e.g. 22] - Mythril version: output from `myth --version` or `pip show mythril` - Solidity compiler and version: `solc --version` +- Python version: `python -V` +- OS: [e.g. iOS] +- OS Version [e.g. 22] ## Additional Environment or Context