lundegaard / lundegaard/validarium
Missing READMEs
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 28
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
- Main README should contain sections:
- Features - what the lib is for
- Installation
- Getting started
- Guides
- How to implement own validations
- Integration to redux-form
- Integration to formik
- Contribution
- Link to API
- Every package should contain link to main page to our repo.
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 by locating the main README and the README files for each package in the repository. Add the requested Features, Installation, Getting started, Guides, Contribution, and API-link sections, including the validation, redux-form, and formik guides. Done means every package links back to the repository's main page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100