How do we want to document clang-tidy and clang-format config options?
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- C++
- Sterne
- 74
- Forks
- 9
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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?
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die clang-tidy- und clang-format-Konfigurationsdateien sowie jegliche README-Dokumentation im Repository zu lokalisieren. Vergleiche die verfügbaren Stellen zum Erklären von Konfigurationsoptionen und kläre anschließend, welche Optionen abgedeckt werden müssen und ob die Dokumentation in den Konfigurationsdateien oder im README erfolgen soll. Die Aufgabe ist abgeschlossen, wenn das Projekt einen vereinbarten Dokumentationsort hat und die relevanten Optionen dort dokumentiert sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- cpp
- Bereich
- documentation, tooling
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 20/100