Developers documentation
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Documentazione
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- python
- Ambito
- api, backend, documentation
Direzione di ricerca
Inizia con la documentazione attuale dell'API all'indirizzo https://kernelci.org/docs/api/ e confrontala con il codice dell'API per identificare le aree consolidate adatte alla documentazione per i contributori. Documenta gli elementi interni stabili dell'API, i modelli, le guide pratiche per gli sviluppatori e la configurazione; il lavoro sarà completato quando i contributori potranno comprendere queste aree e lavorarci senza dover fare affidamento soltanto sul codice.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- Python
- Stelle
- 10
- Fork
- 21
- Merge medio
- 22m
- PR unite (30g)
- 1
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Nessun modello di pull request
- Nessuna guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di kernelci/kernelci-api
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
kernelci/kernelci-api#706 ·
-
Components/Maestro/API/Local instance says GET /latest/ should return some JSON, but it doesn'tForse di nuovo libera Una pull request per questa issue è stata chiusa senza essere unita. Apertadocumentation
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
kernelci/kernelci-api#632 · 1 commento ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 20/100
kernelci/kernelci-api#629 ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
kernelci/kernelci-api#608 ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
kernelci/kernelci-api#597 · 2 commenti ·
Tutte le issue di kernelci/kernelci-api
Issue simili
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
topoteretes/cognee#5647 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
Sendspin/sendspin-python-cli#291 ·
I maintainer di solito rispondono entro 6 giorni
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
awslabs/visual-asset-management-system#414 ·
I maintainer di solito rispondono entro 1 giorno
-
bug v1 v2
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
modelcontextprotocol/python-sdk#3670 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
aicell-lab/bioengine#232 ·
I maintainer di solito rispondono entro 1 giorno