chapel-lang/chapel

[Documentation]: Expand docs for chplcheck rules

Open

#27.339 aperta il 3 giu 2025

Vedi su GitHub
 (7 commenti) (0 reazioni) (1 assegnatario)Chapel (446 fork)auto 404
area: Docsgood first issue

Metriche repository

Star
 (2010 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Today, we document all of the chplcheck rules: https://chapel-lang.org/docs/main/tools/chplcheck/chplcheck.html#current-rules

But for each one we can include an example of where the rule would warn by adding new files to tools/chplcheck/examples. We should expand the list of files here to expand the chplcheck rule documentation

Guida contributor

Direzione di ricerca
Studia la documentazione esistente delle regole chplcheck e la directory degli esempi. Crea nuovi file di esempio seguendo il modello esistente, poi aggiorna la documentazione per collegarli.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
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.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitChapel
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80