Improve documentation for Attribution
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 45/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- python, yaml
- Área
- cli, documentation
Línea de trabajo
Comienza localizando la documentación de ABCTK y la salida de ayuda del comando transform, especialmente la función --help--format mencionada en el issue. Reorganiza la documentación de alto nivel en las secciones Attribution y archivos ABOUT, colocando attrib y transform bajo Attribution. Se considera terminado cuando el contenido YAML de transform está explicado en la documentación sin requerir una instalación de ABCTK.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Within the ABCTK documentation, we should make a distinction between the features and functions that operate on ABOUT files and those that do not require ABOUT files - namely Attribution. This means that we should organized the documentation at a high level under either Attribution or ABOUT files. The attrib and transform commands would be under Attribution and the rest under ABOUT files.
We also need a much more detailed explanation of the content of the transform yaml files - this could just be a copy of the help text from the --help--format function. We do not want to required someone to install ABCTK just to understand how the transform can work.
- Lenguaje dominante
- Python
- Estrellas
- 100
- Forks
- 48
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Incluye un Dockerfile o un archivo de Docker Compose
- Sin plantilla de pull request
- Sin 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.
Más de aboutcode-org/aboutcode-toolkit
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
-
Update PURLDB with all ABCTK releasesQuizá libre de nuevo @pombredanne la tomó hace 593 días y no hay ningún pull request abierto. AbiertoImportant needs design
aboutcode-org/aboutcode-toolkit#582 · 2 comentarios · 3 asignados ·
-
Enhance `about_resource` to reference multiple files.Quizá libre de nuevo @chinyeungli la tomó hace 246 días y no hay ningún pull request abierto. Abierto
aboutcode-org/aboutcode-toolkit#566 · 2 comentarios · 1 asignado ·
-
Create test file with a few hundred itemsQuizá libre de nuevo @DennisClark la tomó hace 1710 días y no hay ningún pull request abierto. Abierto
aboutcode-org/aboutcode-toolkit#491 · 2 asignados ·
-
Clean up / Organize codeQuizá libre de nuevo @sahil-MK2 la tomó hace 1729 días y no hay ningún pull request abierto. Abierto
aboutcode-org/aboutcode-toolkit#483 · 1 comentario · 2 asignados ·
Todos los issues de aboutcode-org/aboutcode-toolkit
Issues similares
-
factory
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Arize-ai/phoenix#17420 · 1 comentario · 1 reacción ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
FireDynamics/LEDSmokeAnalysis#176 ·
Los mantenedores suelen responder en 1 día
-
PC
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
Los mantenedores suelen responder en 1 día
-
Make `ocifs` optionalAbiertodependencies
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
dlt-contrib/dlt-filesystem#51 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día