moja-global / moja-global/FLINT.Reporting
Source Code Organization needs to be updated.
Open
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 9
- Forks
- 17
- PR merge metrics
- No merged PRs in 30d
Description
Current documentation state
- The current document is following the old structure of the project that needs to be changed, and it is not containing any information about the project,
- Microservices details are not present in the document.
- Various metadata files are not mentioned in the documentation.
Outdated Structure of the project
New Structure of the project
Similarly the structure of the microservice needs to be changed.
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
Locate the current source-code organization documentation and compare it with the repository's current structure, including the microservices and metadata files. Update the document to describe the current project and structures, with no outdated organization remaining.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100