MettaChain/PropChain-contract

Document the three lending test modules' purpose

Fechada

#785 aberto em 23 de jul. de 2026

Ver no GitHubGuia do colaborador
 (4 comentários) (0 reação) (1 responsável)Rust (151 forks)auto 404
Stellar WaveTrivial Complexitydocumentationgood first issue

Métricas do repositório

Stars
 (1 estrela)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Adicione comentários de documentação aos três blocos 'mod tests' em contracts/lending/src/lib.rs descrevendo seu propósito, garantindo que sejam renderizados com cargo doc.
Pilha de tecnologia
rust
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
RustGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85