kernelci / kernelci/kernelci-api
Developers documentation
- Linguagem predominante
- Python
- Estrelas
- 10
- Forks
- 21
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Descrição
The current [documentation](https://kernelci.org/docs/api/) 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.
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
Direção de pesquisa
Comece pela documentação atual da API em https://kernelci.org/docs/api/ e compare-a com o código da API para identificar áreas consolidadas adequadas para a documentação de contribuidores. Documente os componentes internos estáveis da API, os modelos, os guias práticos para desenvolvedores e a configuração; o trabalho estará concluído quando os contribuidores puderem entender essas áreas e trabalhar com elas sem depender apenas do código.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- python
- Domínio
- api, backend, documentation
- Tipo de issue
- Documentação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Status de atividade
- Estagnada
- Clareza
- Precisa de esclarecimento
- Facilidade para iniciantes
- 25/100