How do we want to document clang-tidy and clang-format config options?
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
Would it be useful to add documentation in the config files about different clang-tidy options for example? Or would we rather document in a readme?
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
Commencez par localiser les fichiers de configuration de clang-tidy et clang-format ainsi que toute documentation README dans le dépôt. Comparez les emplacements disponibles pour expliquer les options de configuration, puis déterminez quelles options doivent être couvertes et si la documentation doit se trouver dans les fichiers de configuration ou dans le README. Le travail est terminé lorsque le projet dispose d’un emplacement de documentation convenu et que les options pertinentes y sont documentées.
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é
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 20/100