easystats / easystats/datawizard
Improve `README`
Open
Nobody has claimed this yet.
Docs 📚
- Dominant language
- R
- Stars
- 238
- Forks
- 18
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 4
Description
Instead of being a feature dump, it should describe the package goals.
When ready, including https://github.com/easystats/datawizard/issues/87 will also improve things.
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 the README and review the package's current presentation alongside issue #87. Rework the README so it describes the package goals rather than serving mainly as a feature dump; consider the linked issue as part of the intended improvement.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100