Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Enhanced bug report in github muC repo and in muC itself #934

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
Merged
merged 7 commits into from
May 26, 2023
Merged

Enhanced bug report in github muC repo and in muC itself #934

merged 7 commits into from
May 26, 2023

Conversation

@pskowronek
Copy link
Member

  • For muC github repo added bug/issue & feature templates (fields based on RSyntaxTextArea repo)
  • For muCommander - Report a bug now is able to pre-fill the following fields: muC version, java version, OS version, logs.

It's been tested on this repo:
https://github.com/pskowronek/parametrized_issue_template and a bug finally created looks like this: pskowronek/parametrized_issue_template#2

Bug report page initiated from within muC looks like this then:
parametrized_issue_template - ok

@pskowronek pskowronek requested a review from ahadas as a code owner May 14, 2023 10:24
ahadas
ahadas reviewed May 20, 2023
View reviewed changes
Copy link
Member

@ahadas ahadas left a comment

Choose a reason for hiding this comment

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

this looks really nice @pskowronek!
it can save us from the common ping-pong for getting more information
the 'description', 'steps to reproduce', 'expected behavior' and 'actual behavior' are really mandatory but I think we can be a bit more tolerant about the others to ease filing issues - how about saying for the version that we fix only issues on the latest stable release and to ask users to specify a version only if they use a nightly build? I'd also make the Java version field non-mandatory as it's usually bundled now but to say "if non-bundled Java is used, please specify its version". and we can also make the OS field non-mandatory but that's less important because people should easily tell what operating system they use. wdyt?

@pskowronek
Copy link
Member Author

how about saying for the version that we fix only issues on the latest stable release and to ask users to specify a version only if they use a nightly build? I'd also make the Java version field non-mandatory as it's usually bundled now but to say "if non-bundled Java is used, please specify its version". and we can also make the OS field non-mandatory but that's less important because people should easily tell what operating system they use. wdyt?

From my observations we end up asking ppl for muC version or java version :) What I would change is the description - to something like this 'Please copy-paste the version shown in About'. We may also make it optional. WDYT?

pskowronek
pskowronek commented May 20, 2023
View reviewed changes
mucommander-core/src/main/java/com/mucommander/ui/action/impl/ReportBugAction.java Outdated
//url = "https://github.com/pskowronek/parametrized_issue_template/issues/new";
String ver = String.format(Activator.portable ? "%s (%s)" : "%s", RuntimeConstants.VERSION, Translator.get("portable"));
String java_ver = String.join(System.lineSeparator(),
System.getProperty("java.version"),
Copy link
Member Author

Choose a reason for hiding this comment

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

And a common place to generate that info should be created to be also used by AboutDialog

Copy link
Member

Choose a reason for hiding this comment

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

yeah, there's a room for refactoring there, maybe to use JavaVersion#getRawSystemProperty

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok, I will take a look

Copy link
Member Author

Choose a reason for hiding this comment

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

I've taken a look - I'm not convinced to have any common place for those versions. I would leave it as is.

@ahadas
Copy link
Member

ahadas commented May 20, 2023

From my observations we end up asking ppl for muC version or java version :) What I would change is the description - to something like this 'Please copy-paste the version shown in About'. We may also make it optional. WDYT?

yeah, makes sense - the easier it is to find and provide the information, the better

pskowronek
pskowronek commented May 20, 2023
View reviewed changes
pskowronek
pskowronek commented May 20, 2023
View reviewed changes
@pskowronek
Copy link
Member Author

From my observations we end up asking ppl for muC version or java version :) What I would change is the description - to something like this 'Please copy-paste the version shown in About'. We may also make it optional. WDYT?

yeah, makes sense - the easier it is to find and provide the information, the better

See my comments to bug_report.yml - the information how to get versions is already there.

@pskowronek pskowronek changed the title [PoC] Enhanced bug report in github muC repo and in muC itself Enhanced bug report in github muC repo and in muC itself May 20, 2023
ahadas
ahadas reviewed May 25, 2023
View reviewed changes
Copy link
Member

@ahadas ahadas left a comment

Choose a reason for hiding this comment

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

it seems like the entire AboutDialog file has changed - it would be great if you can help me identifying the changes that were done there, other than that lgtm

@pskowronek
Copy link
Member Author

it seems like the entire AboutDialog file has changed - it would be great if you can help me identifying the changes that were done there, other than that lgtm

See "this - REMOVED LINE" comment - this is the only change, the rest is CRLF->LF conversion plus tabs->spaces (the very first commit with cleaning only)

@ahadas
Copy link
Member

ahadas commented May 26, 2023 •
edited
Loading

it seems like the entire AboutDialog file has changed - it would be great if you can help me identifying the changes that were done there, other than that lgtm

See "this - REMOVED LINE" comment - this is the only change, the rest is CRLF->LF conversion plus tabs->spaces (the very first commit with cleaning only)

is it within the code or where can I find this comment?

@ahadas
Copy link
Member

ahadas commented May 26, 2023 •
edited
Loading

@pskowronek I tried to isolated the changes by applying the formatter and change CRLF to CL in AboutDialog on the master branch separately but now the rebase fails on conflicts..

ahadas
ahadas approved these changes May 26, 2023
View reviewed changes
Copy link
Member

@ahadas ahadas left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I reverted the changes in AboutDialog that were obscured by code refactoring - it doesn't seem to break anything so if the changes in AboutDialog are still relevant, please post them separately

@ahadas ahadas merged commit 3a55b74 into mucommander:master May 26, 2023
@pskowronek
Copy link
Member Author

I reverted the changes in AboutDialog that were obscured by code refactoring - it doesn't seem to break anything so if the changes in AboutDialog are still relevant, please post them separately

OK, it looks good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ahadas ahadas ahadas approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@pskowronek @ahadas