smartcontractkit / smartcontractkit/chainlink-cosmos
Populate READMEs with relevant documentation
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 23
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
A lot of documentation is currently missing from the repository.
We should consider adding substantial documentation under ./docs but also populate README.md files for the repo itself and other important subdirectories.
The documentation should enable users to better understand the codebase, but also provide step-by-step tutorials on how to set up the system and run it e2e.
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 by reviewing the repository's existing ./docs directory, README.md, and README files in important subdirectories, then map the codebase areas that need explanation. Define a documentation plan covering setup, end-to-end execution, and repository orientation; this is done when users can understand the codebase and follow the setup and e2e tutorials.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100