Developers documentation
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- python
- Área
- api, backend, documentation
Línea de trabajo
Comienza con la documentación actual de la API en https://kernelci.org/docs/api/ y compárala con el código de la API para identificar áreas consolidadas adecuadas para la documentación de contribuidores. Documenta los elementos internos estables de la API, los modelos, las guías prácticas para desarrolladores y la configuración; el trabajo estará terminado cuando los contribuidores puedan entender esas áreas y trabajar con ellas sin depender únicamente del código.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
The current documentation is still fairly incomplete and high-level. It conveys the purpose of the new API and pipeline and it presents basic usage for the simplest use cases, which is a good way to start getting the attention of potential users, but at this point it still doesn't contain any relevant information for contributors: API internals, models, howtos for developers, configuration, etc.
This suggests that parts of the design are still in flux and not fully stabilized.
Any person that wants to contribute needs to read and understand the code, which also lacks proper documentation in most places. This is risky because a contributor might draw certain design conclusions from the code that may not be right or that could be provisional.
Adding a stable documentation for the API parts that are well established should be a priority to encourage external contributions.
- Lenguaje dominante
- Python
- Estrellas
- 10
- Forks
- 21
- Merge medio
- 22 min
- PR fusionados (30 d)
- 1
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 kernelci/kernelci-api
-
Optimize node collection indexesAbierto
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
kernelci/kernelci-api#706 ·
-
Components/Maestro/API/Local instance says GET /latest/ should return some JSON, but it doesn'tQuizá libre de nuevo Un pull request para esta issue se cerró sin fusionarse. Abiertodocumentation
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
kernelci/kernelci-api#632 · 1 comentario ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
kernelci/kernelci-api#629 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
kernelci/kernelci-api#608 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
kernelci/kernelci-api#597 · 2 comentarios ·
Todos los issues de kernelci/kernelci-api
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
UKGovernmentBEIS/inspect_ai#5781 ·
Los mantenedores suelen responder en 2 días
-
Bump .cicd to wamp-cicd 4c2f9ac: `just land` refuses open A18 decisions, `just where` lists themAbierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 82/100
crossbario/cfxdb#139 ·
-
Bump .cicd to wamp-cicd 4c2f9ac: `just land` refuses open A18 decisions, `just where` lists themAbierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 84/100
crossbario/txaio#241 ·
-
UX
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
mediajunkie/piper-morgan-product#1963 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 64/100