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

enh(debugArchive): Add reminder to redact before sharing #6238

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/gui/generalsettings.cpp
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/*

Check notice on line 1 in src/gui/generalsettings.cpp

View workflow job for this annotation

GitHub Actions / build

Run clang-format on src/gui/generalsettings.cpp

File src/gui/generalsettings.cpp does not conform to Custom style guidelines. (lines 504)
* Copyright (C) by Daniel Molkentin <[email protected]>
*
* This program is free software; you can redistribute it and/or modify
Expand Down Expand Up @@ -501,7 +501,7 @@
}

createDebugArchive(filename);
QMessageBox::information(this, tr("Debug Archive Created"), tr("Debug archive is created at %1").arg(filename));
QMessageBox::information(this, tr("Debug Archive Created"), tr("Redact information deemed sensitive before sharing! Debug archive created at %1").arg(filename));
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think that what would be better is to warn that this may have sensitive data and people should be considerate before sharing (and may want to redact some info if needed)
I am pretty sure as an user I would be so afraid of sharing the debug archive once I would have read this text
if that means that the bug affecting me cannot be solved, then there is an lost opportunity

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 wonder if maybe we tackle this problem in two parts (aiming to achieve all three of: better bug reports + streamlining log request while triaging + increased comfort with providing logs to reduce lost opportunities) by doing something like:

  • Add a README section that is about providing debug logs that encourages people to reproduce on a test account if they're hesitant (which will have less privacy concerns); also provides a convenient spot to direct people to on "how to get logs" (and where, if we so choose down the road, to add maybe a few key bits to search and replace out if one is concerned with sensitive details when they can't use a test account or whatever)
  • Make the message in this PR softer (which I think is what you're proposing)

}

void GeneralSettings::slotShowLegalNotice()
Expand Down
Loading