line / line/centraldogma-python
Add simple examples to README.md
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 21
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
README.md could be a gentle guide for users to start centraldogma-python for the first time.
Examples:
https://github.com/line/centraldogma-go
https://github.com/line/centraldogma-rs
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
Start with README.md and compare the getting-started material in the linked centraldogma-go and centraldogma-rs repositories. Add simple first-use examples for the Python client, with enough context for a new user to follow them; the README should clearly guide a first-time setup and usage flow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100