mapbox / mapbox/node-cpp-skel

Improving code formatting docs with additional efficiency recommendations

Ouverte
#97 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

help wanted
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-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:

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. 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

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.