Little0smit / Little0smit/MiniGames
Proper JavaDoc Commenting of Code
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Java
- Stars
- 1
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Code was done quick with very limited comments, needs to be properly commented with JavaDoc styling.
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.
Research direction
The issue does not name any files, classes, tests, or entry points. Start by surveying the Java source files to determine the scope of the missing JavaDoc, then document the agreed public code and verify that the targeted classes and methods have JavaDoc comments.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100