smartcontractkit / smartcontractkit/chainlink-cosmos
Improve the contracts inline docs (docstrings)
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 23
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
We should strive to properly document all relevant parts of the on-chain contracts (programs), and especially the public functions.
crates/owned/src/lib.rs for example shows some inconsistencies as some public functions have docs and others don't. Review and improve the docstrings of this and other modules.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with crates/owned/src/lib.rs and review its public functions for inconsistent or missing docstrings. Then inspect other on-chain contract modules for the same issue. Done means the relevant public functions and other important contract components have consistent, useful inline documentation; no tests are mentioned in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- blockchain, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100