linkedin / linkedin/python-avro-json-serializer
Better doc
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 135
- Forks
- 43
- PR merge metrics
- No merged PRs in 30d
Description
Hi,
I'm a user of your library, it's great.
I had a couple of suggestion to improve the doc:
- add how to install w/ pip
- add imports statement to the examples
- add deserialize example
I can actually do it if you want.
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 locating the project’s current documentation and examples, then review how installation and serialization are currently described. Update the documentation to include pip installation, imports in examples, and a deserialize example; done means all three requests are covered and the examples remain understandable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100