Skip to content

Commit b275d34

Browse files
committed
Go over docs
1 parent 0a46b3a commit b275d34

File tree

3 files changed

+78
-82
lines changed

3 files changed

+78
-82
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 19 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -5,42 +5,34 @@ about: Tell us about decompyle3 bugs
55
---
66

77
<!-- __Note:__ If you are using this program to do something illegal - don't.
8-
The issue may be flagged to make it easier for those looking for illegal activity.
8+
The issue may be flagged to make it easier for those seeking to report illegal activity.
99
1010
If you are reporting a bug in decompilation, it will probably not be acted upon
11-
unless it is narrowed to a small example. You may have to do some work remove
11+
unless it is narrowed to a small example. You may have to do some work to remove
1212
extraneous code from the source example. Most bugs can be expressed in 30 lines of
1313
code.
1414
1515
Bugs are not for asking questions about a problem you
1616
are trying to solve that involve the use of decompyle3 along the way,
1717
although I may be more tolerant of this if you sponsor the project.
1818
19-
Bugs are also not for general or novice kind help on how to install
19+
Bugs are also not for general or novice help on how to install
2020
this Python program and its dependencies in your environment, or in
2121
the way you would like to have it set up, or how to interpret a Python
22-
traceback e.g. that winds up saying Python X.Y.Z is not supported.
22+
traceback, e.g., that winds up saying Python X.Y.Z is not supported.
2323
24-
For these kinds of things, you will save yourself time by asking
25-
instead on forums like StackOverflow that are geared to helping people
26-
for such general or novice kinds questions and tasks. And unless you
27-
are a sponsor of the project, if your question seems to be of this
28-
category, the issue may just be closed.
24+
For these kinds of things, you will save yourself time by asking instead on forums like StackOverflow or ChatGPT that are geared to helping people with such general or novice kinds of questions and tasks. And unless you are a sponsor of the project, if your question seems to be of this category, the issue may just be closed.
2925
30-
Also, the unless you are a sponsor of the project, it may take a
26+
Also, unless you are a sponsor of the project, it may take a
3127
while, maybe a week or so, before the bug report is noticed, let alone
3228
acted upon.
3329
34-
To set expectations, some legitimate bugs can take years to fix, but
35-
they eventually do get fixed.
30+
To set expectations, some legitimate bugs can take years to fix, but most eventually do get fixed.
3631
37-
Funding the project was added to partially address the problem that there are
38-
lots of people seeking help and reporting bugs, but few people who are
32+
Funding the project was added to partially address the problem that there are lots of people seeking help and reporting bugs, but few people who are
3933
willing or capable of providing help or fixing bugs.
4034
41-
Tasks or the kinds of things others can do, but you can't do or don't
42-
want to do yourself are typically the kind of thing that you pay
43-
someone to do, especially when you are the primary beneficiary of the
35+
Tasks or the kinds of things others can do, but you can't do or don't want to do yourself, are typically the kind of thing that you pay someone to do, especially when you are the primary beneficiary of the
4436
work, or the task is complex, long, or tedious. If your code is over
4537
30 lines long, it fits into this category.
4638
@@ -57,13 +49,13 @@ Prerequisites/Caveats
5749
disassembler and produces valid results.
5850
* Try to make the bytecode that exhibits a bug as small as possible.
5951
* Don't put bytecode and corresponding source code on any service that
60-
requires registration to download. Instead attach it as a zip file.
61-
* When you open a bug report there is no privacy. If you need privacy, then
52+
requires registration to download. Instead, attach it as a zip file.
53+
* When you open a bug report, there is no privacy. If you need privacy, then
6254
contact me by email and explain who you are and the need for privacy.
6355
But be mindful that you may be asked to sponsor the project for the
6456
personal and private help that you are requesting.
6557
* If the legitimacy of the activity is deemed suspicious, I may flag it as suspicious,
66-
making the issue even more easy to detect.
58+
making the issue even easier to detect.
6759
6860
Bug reports that violate the above may be discarded.
6961
@@ -75,10 +67,9 @@ Bug reports that violate the above may be discarded.
7567

7668
## How to Reproduce
7769

78-
<!-- Please show both the *input* you gave and the
79-
output you got in describing how to reproduce the bug:
70+
<!-- Please show both the *input* you gave and the output you got in describing how to reproduce the bug.
8071
81-
or give a complete console log with input and output
72+
Or give a complete console log with input and output
8273
8374
```console
8475
$ decompyle3 <command-line-options>
@@ -95,8 +86,8 @@ can add that too.
9586
## Output Given
9687

9788
<!--
98-
Please include not just the error message but all output leading to the message which includes echoing input and messages up to the error.
99-
For a command-line environment include command invocation and all the output produced.
89+
Please include not just the error message, but all output leading to the message, which includes echoing input and messages up to the error.
90+
For a command-line environment, include command invocation and all the output produced.
10091
10192
If this is too long, then try narrowing the problem to something short.
10293
-->
@@ -114,7 +105,7 @@ Please modify for your setup
114105
115106
- Decompyle3 version: output from `decompyle3 --version` or `pip show decompyle3`
116107
- Python version for the version of Python the byte-compiled the file: `python -c "import sys; print(sys.version)"` where `python` is the correct CPython or PyPy binary.
117-
- OS and Version: [e.g. Ubuntu bionic]
108+
- OS and Version: [e.g., Ubuntu bionic]
118109
119110
-->
120111

@@ -124,8 +115,8 @@ Please modify for your setup
124115

125116
## Priority
126117

127-
<!-- If this is important for a particular public good state that here.
128-
If this is blocking some important activity let us know what activity it blocks.
118+
<!-- If this is important for a particular public good state it here.
119+
If this is blocking some important activity, let us know what activity it blocks.
129120
130121
Otherwise, we'll assume this has the lowest priority in addressing.
131122
-->

0 commit comments

Comments
 (0)