MettaChain/PropChain-contract

Document the three lending test modules' purpose

Fermée

#785 ouverte le 23 juil. 2026

Voir sur GitHubGuide contributeur
 (4 commentaires) (0 réaction) (1 personne assignée)Rust (151 forks)auto 404
Stellar WaveTrivial Complexitydocumentationgood first issue

Métriques du dépôt

Stars
 (1 étoile)
Métriques de merge PR
 (Métriques PR en attente)

Description

Problem Statement

contracts/lending/src/lib.rs contains three mod tests blocks plus test.rs; new contributors can't tell which to extend.

Why it matters

Discoverability keeps test coverage from rotting.

Technical Context

Add a doc-comment for each mod tests block describing intent.

Expected Outcome

Each block carries a 2-line rustdoc header.

Acceptance Criteria

  1. cargo doc --no-deps renders descriptions.
  2. PR template points to the right file.
  3. README mentions layout.

Implementation Notes

Hand-write headers.

Files or modules likely to be affected

contracts/lending/src/lib.rs.

Dependencies

#4 (test split).

Difficulty level

EASY.

Estimated effort

XS (~1 hour).

Guide contributeur

Direction de recherche
Ajoutez des commentaires de documentation aux trois blocs 'mod tests' dans contracts/lending/src/lib.rs décrivant leur objectif, en vous assurant qu'ils sont rendus avec cargo doc.
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.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
RustGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85