MettaChain/PropChain-contract

Document the three lending test modules' purpose

Chiusa

#785 aperta il 23 lug 2026

Vedi su GitHubGuida contributor
 (4 commenti) (0 reazioni) (1 assegnatario)Rust (151 fork)auto 404
Stellar WaveTrivial Complexitydocumentationgood first issue

Metriche repository

Star
 (1 stella)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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).

Guida contributor

Direzione di ricerca
Aggiungi commenti di documentazione ai tre blocchi 'mod tests' in contracts/lending/src/lib.rs descrivendo il loro scopo, assicurandoti che vengano renderizzati con cargo doc.
Tech stack
rust
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
RustGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85