Stirling-PDF icon indicating copy to clipboard operation
Stirling-PDF copied to clipboard

Improve issue quality: include more explicit note to attach relevant example files (when available)

Open balazs-szucs opened this issue 3 months ago • 1 comments

When users report bugs or issues or feature request, they often forget (or simply don't know that it is useful for us) to include the specific file(s) that are affected by the problem or if it's a feature request then it can be tested with their files (alongside with others). This is especially important when there is certain uniqueness in the files that not necessary easy to recreate; e.g., it is a "realistic" file, it is a lesser used file format (conversion related), etc...

This also allows us the rely more PDFDebugger and more sophisticated methods to investigate potential issues or bugs.

I obviously understand this may not always be possible, so I suggest a gentle reminder for example some checkbox (not necessary want this specific language but I think you get the point), and I also propose including a kind privacy guidance, so that if people choose to submit files, they are reminded to NOT submit sensitive content. (this is something that is missing when we currently ask people for files and might lead to issues.)

Example:

Please double-check for sensitive content and remove it when submitting files (e.g., name, TelNr, address)

  • [ ] If possible, please attach an example file(s) (input and output) that helps us understand the issue better. It would be greatly appreciated

balazs-szucs avatar Sep 23 '25 11:09 balazs-szucs

can u assign this too me?

aaryyya avatar Oct 31 '25 18:10 aaryyya