Qual è il modo abituale di condividere uno snippet di codice per illustrare un bug segnalato su GitHub?

0

Ho segnalato un bug su GitHub, ora mi chiedono i file, ma non c'è modo di collegarli al problema sollevato (ad es. su Launchpad puoi allegare un file a un bug report, ma su GitHub c'è solo l'opzione per allegare immagini).

Ho letto la sezione dei problemi delle FAQ di GitHub, ma non ho trovato nulla di sufficientemente illuminante. Sembra che un utente inesperto sia implicitamente diretto dal sito da qualche parte, ma dove?

Dovrei semplicemente creare un repository e mettere lì tutti gli snippet e i file di output richiesti? O dovrei semplicemente mandare via email i file al manutentore del progetto? Quello che sto chiedendo qui si riduce a questo: cosa fanno di solito le persone?

    
posta ThreefoldBurly 14.02.2015 - 14:22
fonte

2 risposte

1

Se stai puntando a linee specifiche nella base di codice, puoi utilizzare collegamenti di linea per effettuare il deep-link nel codice. (Dovresti scegliere un commit specifico e non solo puntare al master in quanto quei link potrebbero diventare obsoleti se il codice cambia.)

Se vuoi solo inserire un codice di esempio che hai creato, è perfetto per Github Gists . Questi possono anche essere clonati e aggiornati come un normale repo, ma sono molto più leggeri.

Se hai un codice che può essere dimostrato in un browser, usa JSFiddle o simili per creare qualcosa con cui le persone possono vedere e interagire.

Bonus : se stai cercando di dimostrare problemi di prestazioni in JavaScript, puoi usare jsPerf per scrivere un esempio prova.

    
risposta data 14.02.2015 - 17:36
fonte
0

Molti progetti ospitati su github dispongono di un'infrastruttura per il test, ovvero alcuni file di input e output previsti (ad esempio fish-shell ha un tests / directory) È possibile applicare una patch al software (ad es. forca quindi effettuare una richiesta di pull) per aggiungere un ulteriore caso di test che illustri il bug.

Dovresti anche contattare alcuni degli autori principali, probabilmente saranno felici di ricevere un bug report .... E potresti segnalare qualche problema (vedi questo esempio )

Infine, se trovi un bug e sei in grado di correggerlo, forzi il repository, lo aggiusti e fai una richiesta di pull.

    
risposta data 14.02.2015 - 14:36
fonte

Leggi altre domande sui tag