Improving code formatting docs with additional efficiency recommendations
Personne n'a encore pris cette issue.
- Langage dominant
- C++
- Étoiles
- 74
- Forks
- 9
- Métriques de merge des PR
- Aucune PR mergée en 30 j
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)
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Repérez la documentation couvrant .clang-format, make format et la vérification du formatage par Travis. Consultez la référence liée au pre-commit hook et la vidéo sur l’intégration aux éditeurs, puis ajoutez des recommandations pour les deux workflows. Le travail sera considéré comme terminé lorsque les développeurs pourront trouver des instructions concrètes pour mettre en place un hook de formatage et configurer les éditeurs courants afin qu’ils utilisent le clang-format installé par Mason.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- cpp
- Domaine
- documentation, tooling
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- Une demi-journée
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100