MettaChain/PropChain-contract

Document the three lending test modules' purpose

Closed

#785 opened on Jul 23, 2026

View on GitHubContributor guide
 (4 comments) (0 reactions) (1 assignee)Rust (151 forks)auto 404
Stellar WaveTrivial Complexitydocumentationgood first issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Add doc comments to the three 'mod tests' blocks in contracts/lending/src/lib.rs describing their purpose, ensuring they render with cargo doc.
Tech stack
rust
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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
RustGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85