Improving code formatting docs with additional efficiency recommendations
Offen
Dieses Issue hat noch niemand übernommen.
help wanted
- Vorherrschende Sprache
- C++
- Sterne
- 74
- Forks
- 9
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
node-cpp-skel has support for:
- a
.clang-formatstyle file that provides formatting rules (which can be modified/customized) make formatan easy command to run to consistently format all the code (and ensure a consistent version of clang-format is available)- a travis job that runs a check to catch when you've forgotten to format your code and in contains incorrectly formatted code (uses same clang-format version as is used locally by
make format)
We can improve by adding docs/recommendations for developers for how to:
- add a git commit hook to ensure code is formatted (before pushing) - refs http://www.duskborn.com/git-pre-commit-clang-format-hook/
- integrate the mason installed clang-format with common text editors such that formatting happens during coding (like seen in https://youtu.be/uZI_Qla4pNA?t=1904)
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
Finde die Dokumentation, die .clang-format, make format und die Travis-Formatierungsprüfung abdeckt. Sieh dir anschließend die verlinkte Referenz zum pre-commit hook und das Video zur Editor-Integration an und ergänze Empfehlungen für beide Workflows. Als erledigt gilt die Aufgabe, wenn Entwickler umsetzbare Anleitungen zum Einrichten eines Formatierungs-Hooks und zum Konfigurieren gängiger Editoren finden können, damit diese das von Mason installierte clang-format verwenden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- cpp
- Bereich
- documentation, tooling
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- Ein halber Tag
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100