hugapi/hug

hug needs more documentation

Open

#319 geöffnet am 25. Mai 2016

Auf GitHub ansehen
 (10 Kommentare) (8 Reaktionen) (0 zugewiesene Personen)Python (389 Forks)batch import
bugenhancementhelp wanted

Repository-Metriken

Stars
 (6.758 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

hug has a collection of documentations on hug.rest and on the github repo (including examples etc) which has served as a reasonable starting point. However, for continued growth, a wider depth of and a higher quality of documentation is an absolute necessity and it is the number 1 priority for the project.

Feel free to add any ideas for additional documentation sources that could be useful for the project to this issue. The currently known ones are:

  • FAQ
  • Known Issues / Gotchas
  • Best Practices
  • Example starting points
  • Full documentation for all exposed APIs and features

I, and the entire community, would be grateful for any help in this area.

Thanks!

~Timothy

Contributor Guide

Research-Richtung
Tragen Sie zur Dokumentation bei, indem Sie FAQ, Best Practices oder Beispiel Startpunkte für das hug API Framework hinzufügen.
Tech Stack
python
Domain
backend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitPython
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90