Add Java docs
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- java
- Domain
- documentation
Research direction
Locate the ExampleDataGenerator class and inspect nearby Java code for existing documentation conventions. Document that class and the other Java code as appropriate, then verify that the Java code has useful documentation throughout.
Written by the indexing model from the issue text.
Description
The project is completely missing Java code documentation. It would be nice to add those, especially for the ExampleDataGenerator class.
- Dominant language
- TypeScript
- Stars
- 6
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
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.
More from vaadin/example-data
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
vaadin/example-data#48 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 28/100
vaadin/example-data#47 ·
-
Documentation Open
Difficulty 5/5 Over a week Newbie friendliness 20/100
vaadin/example-data#46 · 1 reaction ·
-
Difficulty 1/5 Under an hour Newbie friendliness 42/100
vaadin/example-data#32 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
vaadin/example-data#30 ·
All issues in vaadin/example-data
Similar issues
-
comp/desktop P3 type/bug
Difficulty 1/5 Under an hour Newbie friendliness 92/100
NousResearch/hermes-agent#118866 ·
-
Browser Waiting for: Product Owner
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
getsentry/sentry-javascript#24577 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
agilepathway/label-checker#640 ·
-
Plugin stuck at "loading" on DSH 0.1.6-alpha.2 — turnTail list slot registration missing options.id Open
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
chrisparsons83/flexspotff#153 ·