chipsalliance/chisel

We have no documentation/training on `Mem`

Offen

#2.324 geöffnet am 03.01.2022

Auf GitHub ansehenContributor Guide
 (5 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

Type of issue: documentation

Impact: no functional change

Development Phase: request

Other information

If the current behavior is a bug, please provide the steps to reproduce the problem:

We don't have any documentation that I can find on Mem in the Chisel bootcamp, or the website explanations docs or cookbooks. We only cover SyncReadMem.

What is the current behavior?

What is the expected behavior?

We should probably at least mention this in the explanations section

Please tell us about your environment:

What is the use case for changing the behavior?

Not having undocumented features

Contributor Guide

Research-Richtung
Schauen Sie sich die vorhandene Dokumentation für SyncReadMem im Chisel Bootcamp, in den Erklärungsabschnitten der Website und in den Cookbooks an. Identifizieren Sie, wo Mem erwähnt werden sollte (z. B. neben SyncReadMem in den Speicherprimitiven). Erstellen Sie einen kleinen Abschnitt, der das Verhalten und die Verwendung von Mem beschreibt, ähnlich der Dokumentation von SyncReadMem. Aktualisieren Sie die relevanten Markdown Dateien im Repository.
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.
90