smartcontractkit / smartcontractkit/chainlink-starknet
Document all public Go types
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 60
- Forks
- 31
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 2
Description
Just FYI for now, I'd appreciate we document all our public types with at least a short one-liner.
Originally posted by @krebernisak in https://github.com/smartcontractkit/chainlink-starknet/pull/6#discussion_r878002142
Contributor guide
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
The issue names no files, packages, or tests; start by inventorying exported Go types across the repository and checking existing documentation conventions. Define completion as every public type having at least a short one-line comment, then verify the inventory is complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100