mono/Embeddinator-4000

[general] Improve docs, showcase and contributing section

Open

#160 geöffnet am 22. Apr. 2017

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (1 zugewiesene Person)C# (91 Forks)github user discovery
enhancementhelp wanted

Repository-Metriken

Stars
 (758 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Currently the github page of Embeddinator is lacking detailed information about how it works, where it's useful, how to contribute etc. I consider this as very important.

My suggestions is following: Start with adding a wiki which describes in more detail how to use it, add some examples both to the repository and the wiki and at least at a contributing.md .

Contributor Guide

Research-Richtung
Überprüfen Sie die vorhandene Dokumentation und erstellen Sie dann eine Wiki Seite mit Nutzungsbeispielen und eine CONTRIBUTING.md Datei. Folgen Sie dem vorhandenen Stil des Projekts und verlinken Sie relevante Ressourcen.
Tech Stack
csharp
Domain
documentationdevtools
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
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75