Skip to content

Commit c840481

Browse files
committed
Refine FAQ and bug template
1 parent d129b1b commit c840481

File tree

2 files changed

+163
-125
lines changed

2 files changed

+163
-125
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 8 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,16 @@ assignees: ''
77

88
---
99

10-
Please read this first before report any issue
11-
https://pyarmor.readthedocs.io/en/latest/questions.html
12-
13-
If this issue has been documented and there is solution in FAQ, it will be marked as `documented` and be closed it immediately.
14-
15-
Do not ask questions here but in discussions, it will be closed immediately.
10+
**Please remove this line and all the following lines when submit issue**
1611

17-
A good report should have
18-
19-
- A clear title
20-
- Reproduced steps
21-
- Expected results and actual results
12+
In order to solve your issue quickly, please read this page and try common solutions in the section `Asking questions in GitHub`
13+
https://pyarmor.readthedocs.io/en/latest/questions.html
2214

23-
Please also provide necessary log (but not full log), for example, the whole command options `pyarmor gen` and first 4 logs in the console, paste the text directly, DO NOT paste IMAGE
15+
If it's really a bug, please following the guide in the section `Reporting issues`
2416

25-
```
26-
$ pyarmor gen -O dist --assert-call foo.py
27-
INFO Python 3.10.0
28-
INFO Pyarmor 8.4.0 (trial), 000000, non-profits
29-
INFO Platform darwin.x86_64
17+
为了快速解决你遇到的问题,请务必打开下面的链接并尝试其中关于常见问题的通用解决方案
18+
https://pyarmor.readthedocs.io/en/latest/questions.html
3019

31-
```
20+
如果确认是一个 Bug,建议按照上面链接中的章节 `报告问题` 的规范提交问题报告
3221

33-
In order to save time for both of us, if the bug report is not clear or missing necessary information, it will be marked as `invalid` and be closed immediately.
22+
**在提交报告时候请删除当前行以及上面的所有行**

0 commit comments

Comments
 (0)