The-OAG-Development-Project / The-OAG-Development-Project/Application-Gateway
Improve javadoc of the project
Open
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 88
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
Add at least high level documentation to the code, so that its easier to understand and developers are less prone to choose the wrong classes and methods.
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
No files, classes, methods, or tests are identified in the issue. Start by inventorying the Java code and identifying public classes and methods whose purpose is unclear. Done means the project has high-level Javadoc that helps developers understand the code and choose appropriate classes and methods.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100