FuelLabs/sway

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

Open

#5,091 opened on Sep 5, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Rust (5,421 forks)batch import
documentationgood first issuelib: std

Repository metrics

Stars
 (61,702 stars)
PR merge metrics
 (PR metrics pending)

Description

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

Contributor guide

Research direction
Read the SRC 2 standard and the current implementation of Hasher and Hash in the Sway codebase, then add doc comments following the standard.
Tech stack
rust
Domain
blockchain
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitRust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65