mapbox / mapbox/node-cpp-skel

Improving code formatting docs with additional efficiency recommendations

Offen
#97 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

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-format style file that provides formatting rules (which can be modified/customized)
  • make format an 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:

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Ö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

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.