opensearch-project/demos

[FEATURE][DocBot] README revamp

Aperta

#89 aperta il 6 nov 2023

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari) (18 fork)auto 404
OSCIdocumentationenhancementgood first issue

Metriche repository

Star
 (4 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

Is your feature request related to a problem?

Since starting DocBot we have made a lot of progress however our README.md file has not kept up. We need to describe what the DocBot project does succinctly and give an overview of it's parts.

What solution would you like?

Updated README.md file

Guida contributor

Direzione di ricerca
Esamina il README.md attuale, comprendi la struttura e i componenti del progetto e redigi un README aggiornato che includa una descrizione del progetto, una panoramica delle parti e, eventualmente, istruzioni di installazione/utilizzo.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90