How do we want to document clang-tidy and clang-format config options?
Abierto
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- C++
- Estrellas
- 74
- Forks
- 9
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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?
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza localizando los archivos de configuración de clang-tidy y clang-format y cualquier documentación README del repositorio. Compara los lugares disponibles para explicar las opciones de configuración y, a continuación, aclara qué opciones deben documentarse y si la documentación debe estar en los archivos de configuración o en el README. Se considera terminado cuando el proyecto tenga una ubicación de documentación acordada y las opciones relevantes estén documentadas allí.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- cpp
- Área
- documentation, tooling
- Tipo de issue
- Documentación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 20/100