FluxML/Flux.jl

Figure out consistent code style

Open

#1765 aperta il 12 nov 2021

Vedi su GitHub
 (9 commenti) (0 reazioni) (0 assegnatari)Julia (619 fork)batch import
discussionhelp wanted

Metriche repository

Star
 (4725 star)
Metriche merge PR
 (Merge medio 4h 27m) (2 PR mergiate in 30 g)

Descrizione

I've seen a few of files now in FluxML repos where the diffs ping-pong back and forth between different styles. Most of the discrepancy seems to be around function and type signature whitespace. Trailing whitespace too, my editor config is set to trim them and a surprising number of core files seem to have them.

ChainRulesCore recently added JuliaFormatter to their CI and it seems to be working well, but even just a couple of sentences in CONTRIBUTING.md would go a long way.

Guida contributor

Direzione di ricerca
Il problema suggerisce di implementare JuliaFormatter in CI e di aggiungere linee guida di stile a CONTRIBUTING.md. Rivedi la PR collegata di ChainRulesCore (https://github.com/JuliaDiff/ChainRulesCore.jl/pull/482) per un esempio. Controlla i commenti nel problema per eventuali feedback dei manutentori sulle preferenze di stile. L'obiettivo è produrre una pull request che aggiunga un file di configurazione .JuliaFormatter.toml e aggiorni la guida per i contributori.
Tech stack
Nessuno
Dominio
developer experiencetooling
Tipo issue
Manutenzione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Julia programming basicsUnderstanding of CI/CDCode formatting tools
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75