Developers documentation
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 25/100
- Issue-Typ
- Dokumentation
- Klarheit
- Muss geklärt werden
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- python
- Bereich
- api, backend, documentation
Rechercherichtung
Beginnen Sie mit der aktuellen API-Dokumentation unter https://kernelci.org/docs/api/ und vergleichen Sie sie mit dem API-Code, um etablierte Bereiche zu identifizieren, die sich für die Dokumentation für Contributors eignen. Dokumentieren Sie die stabilen API-Interna, Modelle, How-tos für Entwickler und Konfiguration; abgeschlossen ist die Aufgabe, wenn Contributors diese Bereiche verstehen und mit ihnen arbeiten können, ohne sich ausschließlich auf den Code zu verlassen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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.
- Vorherrschende Sprache
- Python
- Sterne
- 10
- Forks
- 21
- Ø Merge
- 22 Min.
- Gemergte PRs (30 T.)
- 1
Entwicklungsumgebung
- Enthält ein Dockerfile oder eine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Kein Beitragsleitfaden
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus kernelci/kernelci-api
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 45/100
kernelci/kernelci-api#706 ·
-
Components/Maestro/API/Local instance says GET /latest/ should return some JSON, but it doesn'tEvtl. wieder frei Ein Pull Request dazu wurde ohne Merge geschlossen. Offendocumentation
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 35/100
kernelci/kernelci-api#632 · 1 Kommentar ·
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 20/100
kernelci/kernelci-api#629 ·
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100
kernelci/kernelci-api#608 ·
-
password creation: non-fatal bcript error outputEvtl. vergeben @Hao-Chen2337 hat das vor 3 Tagen übernommen. Offen
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 35/100
kernelci/kernelci-api#597 · 2 Kommentare ·
Alle Issues in kernelci/kernelci-api
Ähnliche Issues
-
docs pydanty:is-working
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
pydantic/pydantic-ai#10113 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 77/100
GreedyBear-Project/GreedyBear#1727 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 84/100
ARM-software/CMSIS-DSP#354 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
kiat/codeAssist#391 ·
-
needs triage
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 83/100
darnitdevorg/darnit#587 ·
Maintainer antworten meist innerhalb von 1 Tag