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

(0 commenti) (0 reazioni) (0 assegnatari)C++ (9 fork)auto 404

help wanted

Metriche repository

Star: (74 stelle)
Metriche merge PR: (Metriche PR in attesa)

Descrizione

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)

Guida contributor

Direzione di ricerca: Leggi la documentazione di formattazione esistente nel repository e ricerca le risorse collegate riguardanti i git pre commit hook e l'integrazione con gli editor.
Tech stack: cppnodejs
Dominio: documentationdeveloper experiencetooling
Tipo issue: Documentazione
Difficoltà: 2
Tempo stimato: 1-3 ore
Stato attività: Nuova
Chiarezza: Chiara
Prerequisiti: Git
Adatta ai principianti: 80