Formazione obbligatoria all'onboarding per la formattazione del codice?

Ciao, gestisco https://discourse.bokeh.org e frequento spesso anche https://discuss.python.org. In entrambi i posti, c’è un problema piuttosto grave con i nuovi utenti che non formattano il codice nei loro primi post. Ci sono tipicamente diversi post al giorno sul forum principale di Python in cui gli utenti devono essere corretti. [1] Questo è un enorme e costante dispendio di tempo per molte persone.

Sarebbe possibile avere flussi di onboarding obbligatori, prima che un nuovo utente sia autorizzato a fare un primo post? Sto pensando esplicitamente a un flusso in cui all’utente viene mostrato come effettuare la formattazione del codice, e poi gli viene chiesto di riprodurre manualmente 2-3 righe di codice formattato. Devono completare questo con successo prima di poter postare.


  1. Questo è un problema particolarmente insidioso per Python, poiché l’indentazione è significativa. ↩︎

2 Mi Piace

Hai visto Unformatted Code Detector? Questo ha aiutato con lo stesso problema in altre community.

3 Mi Piace

Sì, direi che ha avuto un successo limitato, per usare un eufemismo, almeno su https://discourse.bokeh.org. Ma per quanto ne so è stato installato anche sul forum Python (non sono un amministratore lì).

2 Mi Piace

Non credo, vedi Unformatted Code Detector - #4 by jeanas - Discourse Feedback - Discussions on Python.org per il quale non ho ricevuto alcun avviso.

Una cosa con cui un onboarding obbligatorio aiuterebbe sono gli screenshot con codice al loro interno, sebbene l’OCR possa presumibilmente essere utilizzato per stampare un avviso su tali post come l’attuale plugin “Unformatted code detector”.

Non seguo Bokeh, quindi non posso giudicare se il plugin stia funzionando bene o meno.

1 Mi Piace

In realtà, il plugin per il rilevamento di codice non formattato è abilitato su discuss.python.org. Ho dato un’occhiata alla categoria Utenti di quel forum (non seguo questa categoria di recente) e, ad essere onesti, sembra molto meglio di quanto non fosse in passato, anche se ci sono ancora alcuni post con codice non formattato.

Per completezza, ecco un esempio di oggi con un ampio blocco di codice (che dovrebbe superare qualsiasi soglia) che il plugin non ha rilevato:

che poi ha innescato una discussione collaterale proprio su questo argomento di onboarding/formattazione del codice, a cui l’OP sembra aver preso un po’ di offesa.

Il plugin è semplicemente rotto o necessita di un aggiornamento? Indipendentemente da ciò, penso ancora che una sfida obbligatoria di “formattare questo codice” prima di poter pubblicare sia un’aggiunta preziosa al “rilevamento automatico”.

1 Mi Piace

Ho appena controllato il componente del tema con i suoi parametri predefiniti e il codice non formattato dell’esempio
sembra funzionare

Non ha certo impedito le oltre 50 righe di codice non formattato nel post collegato, che a questo punto è degenerato in ulteriori contestazioni. :slight_smile:

dovrebbe essere un po’ più coercitivo? magari :roll_eyes:
un primo passo facile potrebbe essere una piccola modifica al testo del pulsante, magari submit potrebbe essere ATTENZIONE !!! o qualcosa del genere…