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.

Sign up for GitHub

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

Jump to bottom

Adding issue template to bug reports in Monero repository. #9146

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Adding issue template to bug reports in Monero repository. #9146

wants to merge 1 commit into from

Conversation

0xFFFC0000
Copy link
Collaborator

@0xFFFC0000 0xFFFC0000 commented Jan 30, 2024 •
edited
Loading

Includes two templates: Bug Report, and Feature Request.

In case you want to look at how it appears in a GitHub report page, hit the New issue button here [1]. In addition to the template, this will assign bug label to bug reports and feature label to feature requests.

  1. https://github.com/0xFFFC0000/monero-perf/issues
@0xFFFC0000 0xFFFC0000 marked this pull request as draft January 30, 2024 10:11
@0xFFFC0000 0xFFFC0000 changed the title Adding issue tempalte to bug reports in Monero repository. Jan 30, 2024
@0xFFFC0000 0xFFFC0000 force-pushed the dev/0xfffc/add-issue-template branch 2 times, most recently from 8d6b9a3 to 1c966b2 Compare January 30, 2024 10:50
@0xFFFC0000 0xFFFC0000 marked this pull request as ready for review January 30, 2024 10:52
@0xFFFC0000 0xFFFC0000 changed the title [DRAFT] Adding issue tempalte to bug reports in Monero repository. Jan 30, 2024
@0xFFFC0000 0xFFFC0000 changed the title Adding issue tempalte to bug reports in Monero repository. Jan 30, 2024
@0xFFFC0000 0xFFFC0000 force-pushed the dev/0xfffc/add-issue-template branch 2 times, most recently from b057ddb to 8b0c222 Compare January 30, 2024 10:56
selsta
selsta reviewed Jan 30, 2024
View reviewed changes
.github/ISSUE_TEMPLATE/bug_report.yml Outdated
description: |
Please copy and paste any relevant log output or attach a debug log file.

You can get log information via --log-level=4 flag or by taking a look at log files at ~/.bitmonero/ in cli version. Or you can look at the log information in Settings->Log section in Monero-GUI.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we should require log-level 4 here, it's extremely noisy, 2 is better for most issues.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider it done. Will change this to level 2.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed it in a new push. We have log-level=2 now.
@Gingeropolous
Copy link
Collaborator

I would include a link to search for existing issues when you ask the user if they've checked.

honestly, I've never liked these templates. I understand their efficiency, but there have been many cases where I'm using open source software, and I come across an issue, so I head to the github to file an issue, and I'm hit with a way-too-involved issue template so I just don't file it. ("I'm an end user, not a debugger!")

and some of these fields will get repetitive for someone who regularly uses monero and finds issues. :)

but this seems less onerous than some templates I've found out there. At least only some of the fields are required.
@0xFFFC0000
Copy link
Collaborator Author

0xFFFC0000 commented Jan 30, 2024 •
edited
Loading

@Gingeropolous It is understandable for users to decide to not report issues for projects that do have many extra mandatory fields in their templates. But the key here is the mandatory word. Without extra, useless mandatory fields, it is quite useful. Without forcing us to put in extra time, these templates do provide much better support. For example, we have users reporting a compilation bug, but they don't even mention what is the os they are using.

Will add a link to search existing issues.
@selsta
Copy link
Collaborator

selsta commented Jan 30, 2024

Personally I would prefer the following fields, it's a good tradeoff between having necessary information and complexity of creating the issue

  • describe the issue
  • logs
  • which version
  • where did you get the binary
  • which OS, hardware
selsta
selsta reviewed Jan 31, 2024
View reviewed changes
.github/ISSUE_TEMPLATE/bug_report.yml Outdated

* General monero questions and/or support requests should use Monero StackExchange at https://monero.stackexchange.com.
* For reporting security issues, please read instructions at https://github.com/monero-project/meta/blob/master/VULNERABILITY_RESPONSE_PROCESS.md.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also add a point that GUI related issues should be reported on the GUI repo.
Copy link
Collaborator Author

@0xFFFC0000 0xFFFC0000 Feb 1, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will be added in new push. Thanks.
.github/ISSUE_TEMPLATE/bug_report.yml Outdated
description: |
Please copy and paste any relevant log output or attach a debug log file.

You can get log information via --log-level=2 flag or by taking a look at log files at ~/.bitmonero/ in cli version. Or you can look at the log information in Settings->Log section in Monero-GUI.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we leave this in? For example the wallet log file is in a different place than the daemon log file, also --log-level=2 affects the log that gets printed and written to the disk, so that "or" doesn't really make sense.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a more detailed comment here in new push. Please don't hesitate to let me know if it needs to change again. Thanks
@0xFFFC0000
Copy link
Collaborator Author

0xFFFC0000 commented Feb 1, 2024 •
edited
Loading

Changelog for last push:

  1. Changed Expected behaviour to a non-mandatory field.
  2. Changed Machine specifications to mandatory field.
  3. Added point about the Monero-GUI repository issue tracker.
  4. Improved the comment about how can user generate logs.

Example: https://github.com/0xFFFC0000/monero-perf/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml
@0xFFFC0000
Adding issue templates to bug reports in Monero repository.
2b088e4 
Includes two templates: Bug Report, and Feature Request.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
low priority
3 participants
@0xFFFC0000 @Gingeropolous @selsta