Improving code formatting docs with additional efficiency recommendations · mapbox/node-cpp-skel

(0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (9 Forks)auto 404

help wanted

Repository-Metriken

Stars: (74 Sterne)
PR-Merge-Metriken: (PR-Metriken ausstehend)

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:

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)

Contributor Guide

Research-Richtung: Lies die vorhandene Formatierungsdokumentation im Repository und recherchiere die verlinkten Ressourcen zu Git Pre Commit Hooks und Editor Integration.
Tech Stack: cppnodejs
Domain: documentationdeveloper experiencetooling
Issue Type: Dokumentation
Schwierigkeit: 2
Geschätzte Zeit: 1-3 Stunden
Aktivitätsstatus: Frisch
Klarheit: Klar
Voraussetzungen: Git
Einsteigerfreundlichkeit: 80