Ygg01/Linguini

Improve docs

Offen

#23 geöffnet am 30.05.2022

Auf GitHub ansehen
 (1 Kommentar) (1 Reaktion) (0 zugewiesene Personen)C# (15 Forks)auto 404
documentationgood first issuehelp wanted

Repository-Metriken

Stars
 (42 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

This is more of a meta issue, so contributors can expand docs and add it.

What docs are needed?

  • API Docs. Easiest to add needed on most public methods
  • How-To. Just a quick cookbook examples how to setup some Linguini in a specific case. No external dependencies needed.
  • Tutorial??. Possibly needed, but Linguini is relatively simple.
  • Onboarding docs for new contributors?? Not sure what people need.

Contributor Guide

Research-Richtung
Überprüfen Sie die vorhandene Dokumentation im Repository, identifizieren Sie Lücken wie fehlende API Dokumentation oder Beispiele, und schlagen Sie Ergänzungen im Stil des Projekts vor.
Tech Stack
csharp
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
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
GitC#
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90