mapbox/node-cpp-skel
Improving code formatting docs with additional efficiency recommendations
Aberta
#97 aberto em 3 de jan. de 2018
help wanted
Métricas do repositório
- Stars
- (74 estrelas)
- Métricas de merge de PR
- (Métricas PR pendentes)
Description
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)