How do we want to document clang-tidy and clang-format config options?
Nessuno ha ancora preso questa issue.
- Lingua principale
- C++
- Stelle
- 74
- Fork
- 9
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
Would it be useful to add documentation in the config files about different clang-tidy options for example? Or would we rather document in a readme?
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia individuando i file di configurazione di clang-tidy e clang-format e qualsiasi documentazione README nel repository. Confronta i punti disponibili per spiegare le opzioni di configurazione, quindi chiarisci quali opzioni devono essere trattate e se la documentazione debba trovarsi nei file di configurazione o nel README. Il lavoro è completato quando il progetto ha una posizione concordata per la documentazione e le opzioni pertinenti sono documentate lì.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- cpp
- Ambito
- documentation, tooling
- Tipo di issue
- Documentazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 20/100