chipsalliance/chisel

Update docs/README.md

Geschlossen

#4.402 geöffnet am 16.09.2024

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Scala (651 Forks)batch import
good first issue

Repository-Metriken

Stars
 (4.658 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 3T 21h) (16 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Aktualisieren Sie die README Datei mit Anweisungen zum Platzieren von Dokumentationsdateien, zum Ausführen von mdoc zur Überprüfung und zum Erstellen der Website für die Vorschau.
Tech Stack
scala
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80