helpshift/mongrove

Improve README

Aperta

#14 aperta il 21 gen 2023

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Clojure (8 fork)auto 404
documentationgood first issue

Metriche repository

Star
 (10 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Improve README doc. Things that can be added:

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

Guida contributor

Direzione di ricerca
Leggi il README attuale, poi aggiungi sezioni per Descrizione, Guida introduttiva, Guida alla contribuzione e link alla documentazione API.
Tech stack
clojure
Dominio
backenddatabase
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitMarkdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90