FuelLabs/sway

Add inline documentation for `Hasher` type and `Hash` trait

Open

#5.091 geöffnet am 5. Sept. 2023

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Rust (5.421 Forks)batch import
documentationgood first issuelib: std

Repository-Metriken

Stars
 (61.702 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 5T 4h) (19 gemergte PRs in 30 T)

Beschreibung

The Hasher and Hash types should follow the documentation outlined in the SRC-2 standard.

Contributor Guide

Research-Richtung
Das Issue erfordert das Hinzufügen von Inline Dokumentation zum Hasher Typ und zum Hash Trait gemäß dem SRC 2 Standard. Die relevanten Dateien befinden sich wahrscheinlich im Verzeichnis `sway lib std`. Es gibt keine verknüpften PRs oder Zuweisungen, daher ist das Issue für neue Mitwirkende verfügbar. Überprüfen Sie den SRC 2 Standard auf spezifische Dokumentationsanforderungen.
Tech Stack
rust
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
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.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Rust basicsFamiliarity with Hash/Hasher typesUnderstanding of SRC 2 standard
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80