Skip to content
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

Merged
merged 4 commits into from
Nov 30, 2023
Merged

chore: optimize issue template #2961

merged 4 commits into from
Nov 30, 2023

Conversation

Keith-CY
Copy link
Collaborator

@Keith-CY Keith-CY commented Nov 25, 2023

  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.

Preview: https://github.com/nervosnetwork/neuron/blob/optimize-issue-template/.github/ISSUE_TEMPLATE/bug_report.yml

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.
@Keith-CY
Copy link
Collaborator Author

Please check if any other fields should be added for debug

@Keith-CY
Copy link
Collaborator Author

Please have a review @Danie0918 @Sven-TBD

@Danie0918
Copy link
Collaborator

Danie0918 commented Nov 30, 2023

  1. Here Detail of the issue, Screenshots and Debug information can be split into 3 modules for more clarity and accessibility.

    Detail of the issue : Mandatory option that requires the user to describe the problem through text.
    Screenshots : Optional, user uploaded screenshot files.
    Debug information : Optional, users only need to upload the debug information zip file.

  2. Follow-up can be appended to the Help Center website.

@Keith-CY
Copy link
Collaborator Author

Screenshots : Optional, user uploaded screenshot files.

The annotation of detail of this issue was updated to Please append detail of the issue here, including steps to reproduce, screenshots, etc. to inform users to upload screenshots.

Detail of the issue : Mandatory option that requires the user to describe the problem through text.
Debug information : Optional, users only need to upload the debug information zip file.

I didn't get this because Detail of the issue is mandatory and Debug information is optional now.

image
  1. Follow-up can be appended to the Help Center website.

Is this a note for other users to track this issue on Helper Center page?

@Danie0918
Copy link
Collaborator

I didn't get this because Detail of the issue is mandatory and Debug information is optional now.

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.

Is this a note for other users to track this issue on Helper Center page?

This is something that can be self-checked before a user creates a new issue, reducing duplicate issues.

@Keith-CY
Copy link
Collaborator Author

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.

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

This is something that can be self-checked before a user creates a new issue, reducing duplicate issues.

It has been mentioned at the start https://github.com/nervosnetwork/neuron/pull/2961/files#diff-637f7b97bba458badb691a1557c3d4648686292e948dbe3e8360564378b653efR13

@Keith-CY Keith-CY added this pull request to the merge queue Nov 30, 2023
Merged via the queue into develop with commit 34533d8 Nov 30, 2023
23 checks passed
@Keith-CY Keith-CY deleted the optimize-issue-template branch November 30, 2023 09:11
yanguoyu pushed a commit to yanguoyu/neuron that referenced this pull request Mar 14, 2024
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants