helpshift/mongrove

Improve README

Ouverte

#14 ouverte le 21 janv. 2023

Voir sur GitHub
 (0 commentaire) (0 réaction) (0 personne assignée)Clojure (8 forks)auto 404
documentationgood first issue

Métriques du dépôt

Stars
 (10 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

Improve README doc. Things that can be added:

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

Guide contributeur

Direction de recherche
Lisez le README actuel, puis ajoutez des sections pour Description, Guide de demarrage, Guide de contribution et lien vers la documentation API.
Stack technique
clojure
Domaine
backenddatabase
Type d'issue
Documentation
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.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitMarkdown
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90