Description
Deny warnings in contracts crate.
Requirements and context
-
Efficient review
-
Clear rollback / no production impact for CI-only tasks
-
Must be secure, fully tested, and documented
-
Should be efficient and easy to review for auditors and integrators
Suggested execution
- Fork the repository and create a branch:
git checkout -b ci/clippy
- Implement the changes listed below
- Open a draft PR early for design feedback
Implement
- Touch
.github/workflows/*.yml or tarpaulin.toml as needed
- Document in
README.md how to run locally
Tests and documentation
- Add or extend automated tests:
cargo test, CI logs
- Add or update documentation:
README.md
- Add Rustdoc (
///) on public contract APIs where applicable (NatSpec-style)
- Validate stated security assumptions explicitly in PR description
Test and commit
- Run the full contract test suite (e.g.
cargo test, Soroban local sandbox if applicable)
- Cover edge cases called out in this issue
- Attach test output summary and short security notes in the PR
- Ensure minimum 95% line coverage for touched modules (
cargo tarpaulin / project standard)
Example commit message
Guidelines
| Item |
Target |
| Test coverage |
≥ 95% on changed code |
| Documentation |
Clear, versioned, matches on-chain behavior |
| Timeframe |
96 hours from assignment |
Description
Deny warnings in contracts crate.
Requirements and context
Efficient review
Clear rollback / no production impact for CI-only tasks
Must be secure, fully tested, and documented
Should be efficient and easy to review for auditors and integrators
Suggested execution
git checkout -b ci/clippyImplement
.github/workflows/*.ymlortarpaulin.tomlas neededREADME.mdhow to run locallyTests and documentation
cargo test, CI logsREADME.md///) on public contract APIs where applicable (NatSpec-style)Test and commit
cargo test, Soroban local sandbox if applicable)cargo tarpaulin/ project standard)Example commit message
Guidelines