-
Notifications
You must be signed in to change notification settings - Fork 85
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: optimize issue template #2961
Conversation
1. Use GitHub's form feature by default; 2. Update submission rules to lead users to help center; 3. Add a field for ckb light client.
Please check if any other fields should be added for debug |
Please have a review @Danie0918 @Sven-TBD |
|
Inform users to upload screenshots to demonstrate the issue clearly
…twork/neuron into optimize-issue-template
Here is where it was felt that pasting debug information was not necessary, took up more space, and would increase the cost of use and reading for the user. Users only need to upload the zip file of debug information.
This is something that can be self-checked before a user creates a new issue, reducing duplicate issues. |
I got this. It's intended and optional, as mentioned at https://github.com/nervosnetwork/neuron/pull/2961/files#diff-637f7b97bba458badb691a1557c3d4648686292e948dbe3e8360564378b653efR44 Uploading a zip file is easy for users, but pasting debug information into an issue facilitates searching. Similar issues could be hit when users search for a snippet of log, e.g. https://github.com/search?q=repo%3Anervosnetwork%2Fneuron+ckb_memory_tracker%3A%3Aprocess&type=issues
It has been mentioned at the start https://github.com/nervosnetwork/neuron/pull/2961/files#diff-637f7b97bba458badb691a1557c3d4648686292e948dbe3e8360564378b653efR13 |
* chore: optimize issue template 1. Use GitHub's form feature by default; 2. Update submission rules to lead users to help center; 3. Add a field for ckb light client. * chore: update description of "detail of the issue" Inform users to upload screenshots to demonstrate the issue clearly
Preview: https://github.com/nervosnetwork/neuron/blob/optimize-issue-template/.github/ISSUE_TEMPLATE/bug_report.yml