seas-computing / seas-computing/mark-one
Add class documentation for mark-one components
Open
Nobody has claimed this yet.
documentation
Technical Debt
- Dominant language
- TypeScript
- Stars
- 0
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Some mark-one components are missing class documentation (for example: BorderlessButton). We should take some time to add that in when possible.
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 src/Buttons/BorderlessButton.tsx, the example named in the issue, and inspect the mark-one components that lack class documentation. Add the missing class documentation to the applicable mark-one components; the work is done when those components are documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation, frontend
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100