JuliaDocs/Documenter.jl

Add a note to contributor docs about how to format code

Open

#2528 aperta il 14 giu 2024

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Julia (513 fork)batch import
Type: Documentationgood first issue

Metriche repository

Star
 (910 star)
Metriche merge PR
 (Merge medio 16g 9h) (3 PR mergiate in 30 g)

Descrizione

https://github.com/JuliaDocs/Documenter.jl/pull/2514#issuecomment-2165219642

We use prettier for js, and also JuliaFormatter as some point hopefully (#2404).

Guida contributor

Direzione di ricerca
Controlla la documentazione esistente per i contributori nel repository, probabilmente in un file CONTRIBUTING.md o nella cartella docs. Guarda il commento PR collegato (https://github.com/JuliaDocs/Documenter.jl/pull/2514#issuecomment 2165219642) per il contesto sugli strumenti di formattazione menzionati. Aggiungi una nota che fa riferimento all'uso di Prettier per i file JavaScript e al piano futuro di usare JuliaFormatter per il codice Julia (issue #2404). La nota deve essere concisa e posizionata nella sezione pertinente della documentazione per i contributori.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90