chipsalliance/chisel

Update docs/README.md

Fermée

#4 402 ouverte le 16 sept. 2024

Voir sur GitHubGuide contributeur
 (2 commentaires) (0 réaction) (0 personne assignée)Scala (651 forks)batch import
good first issue

Métriques du dépôt

Stars
 (4 658 étoiles)
Métriques de merge PR
 (Merge moyen 3j 21h) (16 PRs mergées en 30 j)

Description

It's a bit dated, it needs to tell people where to put docs, how to run mdoc and view the result, and how to build the website to see it rendered.

Guide contributeur

Direction de recherche
Mettez à jour le README avec des instructions sur l'emplacement des fichiers de documentation, l'exécution de mdoc pour vérifier et la construction du site Web pour prévisualisation.
Stack technique
scala
Domaine
documentation
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.
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.
80