Developers documentation
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 25/100
- Type d'issue
- Documentation
- Clarté
- À clarifier
- Activité
- À l'abandon
- Stack technique
- python
- Domaine
- api, backend, documentation
Piste de recherche
Commencez par la documentation actuelle de l’API à l’adresse https://kernelci.org/docs/api/ et comparez-la avec le code de l’API afin d’identifier les domaines établis qui se prêtent à la documentation destinée aux contributeurs. Documentez les éléments internes stables de l’API, les modèles, les guides pratiques pour les développeurs et la configuration ; le travail sera terminé lorsque les contributeurs pourront comprendre ces domaines et travailler avec eux sans dépendre uniquement du code.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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.
- Langage dominant
- Python
- Étoiles
- 10
- Forks
- 21
- Merge moyen
- 22 min
- PR mergées (30 j)
- 1
Préparer son environnement
- Fournit un Dockerfile ou un fichier Docker Compose
- Aucun modèle de pull request
- Aucun guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de kernelci/kernelci-api
-
Optimize node collection indexesOuverte
Difficulté 4/5 3-5 jours Accessibilité débutants 45/100
kernelci/kernelci-api#706 ·
-
Components/Maestro/API/Local instance says GET /latest/ should return some JSON, but it doesn'tPeut-être à nouveau libre Une pull request pour cette issue a été fermée sans être fusionnée. Ouvertedocumentation
Difficulté 3/5 1-2 jours Accessibilité débutants 35/100
kernelci/kernelci-api#632 · 1 commentaire ·
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 20/100
kernelci/kernelci-api#629 ·
-
Difficulté 4/5 3-5 jours Accessibilité débutants 35/100
kernelci/kernelci-api#608 ·
-
Difficulté 3/5 1-2 jours Accessibilité débutants 35/100
kernelci/kernelci-api#597 · 2 commentaires ·
Toutes les issues de kernelci/kernelci-api
Issues similaires
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 85/100
MystenLabs/MemWal#1163 · 2 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
infertopics leaves new nodes without a topic when untopiced neighbours outnumber topiced onesPeut-être pris @moneebullah25 l’a pris aujourd’hui. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
FinanceFlash/unvibecode#218 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
NVIDIA/earth2studio#1241 ·
Les mainteneurs répondent en général sous 3 jours