opensearch-project/demos

[FEATURE][DocBot] README revamp

Ouverte

#89 ouverte le 6 nov. 2023

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée) (18 forks)auto 404
OSCIdocumentationenhancementgood first issue

Métriques du dépôt

Stars
 (4 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Examinez le README.md actuel, comprenez la structure et les composants du projet, et rédigez un README mis à jour comprenant une description du projet, un aperçu des parties et éventuellement des instructions d'installation/d'utilisation.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90