FuelLabs/sway

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

Open

#5 091 ouverte le 5 sept. 2023

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)Rust (5 421 forks)batch import
documentationgood first issuelib: std

Métriques du dépôt

Stars
 (61 702 stars)
Métriques de merge PR
 (Merge moyen 5j 4h) (19 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Le problème nécessite d'ajouter une documentation en ligne au type Hasher et au trait Hash conformément à la norme SRC 2. Les fichiers concernés se trouvent probablement dans le répertoire `sway lib std`. Il n'y a pas de PR liés ni de responsables, donc le problème est disponible pour les nouveaux contributeurs. Consultez la norme SRC 2 pour les exigences spécifiques de documentation.
Stack technique
rust
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.
2
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.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Rust basicsFamiliarity with Hash/Hasher typesUnderstanding of SRC 2 standard
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80