FarManager icon indicating copy to clipboard operation
FarManager copied to clipboard

Automate artifact collection to improve bug reports quality

Open MKadaner opened this issue 5 months ago • 0 comments

By @alabuzhev in https://github.com/FarGroup/FarManager/pull/981#discussion_r2217899768

I can't count how many times there was a bug report I couldn't reproduce because the reporter's configuration was different from mine.

By @MKadaner in https://github.com/FarGroup/FarManager/pull/981#discussion_r2217915940

What do you think of routinely requiring accompanying bug reports with the exported Far configuration (maybe provide a tool to redact PII)?

By @alabuzhev in https://github.com/FarGroup/FarManager/pull/981#discussion_r2217934149

I think we can even export and redact it automatically.

By @MKadaner in https://github.com/FarGroup/FarManager/pull/981#discussion_r2217974795

On a crash, yes. But how about less severe issues? After all, crash dump is pretty much self-contained. At least all settings should be cached in memory. So, unless you have a trick up your sleeve, it should be a script / macro / command to automatically collect artifacts in support of the report. Let's get thing rolling. What needs to be collected?

  • List of active plugins, maybe with some settings.
  • Installed macros.
  • Sysinfo.
  • All Far settings.
  • Relevant system settings, like conhost vs. WT, current code page...
  • Anything else?

Should it be an external script / executable or something which can be activated from within Far?

Originally posted by @alabuzhev in https://github.com/FarGroup/FarManager/pull/981#discussion_r2217979841

On crashes we produce a human-readable report along with the dump (use CtrlAltApps to check it out). In theory it should be possible to reuse most of it to generate similar reports on demand.

MKadaner avatar Jul 20 '25 22:07 MKadaner