JedWatson / JedWatson/react-select
Document defaults
Open
Nobody has claimed this yet.
issue/bug-unconfirmed
- Dominant language
- TypeScript
- Stars
- 28k
- Forks
- 4.1k
- PR merge metrics
- No merged PRs in 30d
Description
It's nice that the props page has types on it, but it's anyone's guess as to what each of the defaults for each of those props are, unless you've already had some experience with the library.
Unless they differ for different variants of the select, can we document those defaults in the prop documentation?
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 at the props page linked in the issue and inspect how the prop documentation is generated or maintained. Document the default value for each prop when it is consistent across variants, and consider the work done when the props page exposes those defaults clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100