Improve Documentation
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Anfängerfreundlichkeit
- 30/100
- Issue-Typ
- Dokumentation
- Klarheit
- Muss geklärt werden
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- python
- Bereich
- developer-experience, documentation
Rechercherichtung
Beginne damit, README.md und die vorhandene Inline-Dokumentation zu überprüfen, um fehlende Hinweise zu Beiträgen und zum Erstellen der Tools zu identifizieren. Dokumentiere die Beitrags- und Build-Workflows des Projekts im README und in der relevanten Inline-Dokumentation. Überprüfe anschließend, dass die Anweisungen vollständig und nutzbar sind, indem du ihnen aus einem sauberen Checkout folgst.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
The documentation should be updated to improve ability for contribution and generally tool build.
This includes in-line documentation and the README.md.
- Vorherrschende Sprache
- Python
- Sterne
- 19
- Forks
- 20
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Entwicklungsumgebung
- Enthält ein Dockerfile oder eine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Beitragsleitfaden lesen
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 CodeForAfrica/HealthTools.API
-
Is it up?Offen
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 20/100
CodeForAfrica/HealthTools.API#138 ·
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 35/100
CodeForAfrica/HealthTools.API#136 ·
-
Update test scriptsOffen
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 35/100
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 20/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 45/100
Alle Issues in CodeForAfrica/HealthTools.API
Ähnliche Issues
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100
Deepak3699/Ai_Mentor#244 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
btclib-org/btclib-node#1880 ·
Maintainer antworten meist innerhalb von 1 Tag
-
CONTRIBUTING.md: say how ticketless bug fixes and feature PRs are handledEvtl. vergeben @khuisman hat das heute übernommen. Offenv0.9.2
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 84/100
khuisman/mcp-gee-sweet#941 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
pyjanitor-devs/pyjanitor#1758 ·
Maintainer antworten meist innerhalb von 1 Tag
-
bug ready for review
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 86/100
odysseus-dev/odysseus#6641 ·
Maintainer antworten meist innerhalb von 1 Tag