helpshift/mongrove

Improve README

Offen

#14 geöffnet am 21.01.2023

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Clojure (8 Forks)auto 404
documentationgood first issue

Repository-Metriken

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

Beschreibung

Improve README doc. Things that can be added:

  1. Description and purpose
  2. Getting started guide
  3. Contributing guide
  4. API doc link

Contributor Guide

Research-Richtung
Lies das aktuelle README und füge Abschnitte für Beschreibung, Einstiegsanleitung, Beitragsanleitung und API Dokumentationslink hinzu.
Tech Stack
clojure
Domain
backenddatabase
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.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitMarkdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90