Improve Readme.md file and provide more info
Ouverte
Personne n'a encore pris cette issue.
- Langage dominant
- JavaScript
- Étoiles
- 11.8k
- Forks
- 7.9k
- Merge moyen
- 1 j 11 h
- PR mergées (30 j)
- 11
Description
Please improve the readme file, the steps to run and install the repo locally are not clear.
I cannot get how do I install it on my system.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par lire le README du dépôt et vérifier les instructions existantes d’installation et d’exécution en local. Mettez à jour le README afin qu’une personne découvrant le projet puisse suivre les étapes de configuration et comprendre comment exécuter le dépôt en local ; l’issue ne nomme pas de fichiers ni de tests spécifiques.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 25/100