Add local diagnostic logging to make bug reports easier and avoid uploading private files

Aperta
  • Qualcosa non va?
#197 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
javascript
Ambito
desktop

Direzione di ricerca

Start by identifying the application’s error handling and logging entry points; the issue does not name specific files or tests. Work out how local logs can capture error details and context without exposing private file contents, and how users can locate or export them. Done means logs stay local, can be attached to a bug report, and the attachment process is documented.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Hi, thanks for maintaining this project.

I'd like to suggest adding a local diagnostic logging system.

When users encounter problems locally—such as files failing to open, files being displayed incorrectly, or operations failing—it is often difficult to provide enough information for debugging. Currently, users may need to upload their private original files to report a bug, which many users are uncomfortable with.

Proposal:

  • When an unexpected error or exception occurs, the application should collect diagnostic logs locally.
  • The logs should include relevant error details, stack traces, and contextual information, while avoiding sensitive file contents where possible.
  • Logs should remain local and should not be uploaded automatically.
  • When reporting a bug, users can simply attach the log file to the GitHub issue instead of uploading their private original files.

Benefits:

  • Users do not need to expose private files.
  • Maintainers get more useful diagnostic information.
  • Bug reports become more accurate and faster to diagnose and fix.

It would also be helpful to provide a simple way to export or locate the log file, and to document how users can attach it to a GitHub issue.

Thanks for considering this suggestion.

Lingua principale
JavaScript
Stelle
7.1k
Fork
732
Merge medio
2h 54m
PR unite (30g)
21

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di HeyPuter/everything

Tutte le issue di HeyPuter/everything

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.