Document packages with package-info.java for clarity
MagicShel opened this issue · comments
Summary
The overall structure of the application is a little confusing or at least the architectural intent is unclear.
Details
Including package-info.java along with a bit of Javadoc can help clarify the intent of each package and make sure features find their right home. This needn't be done all at once (and not all packages need it), but can start at the top level and add on as clarity is required. Relevant stack overflow
Alternatively, this could be documented in a separate README, but should be intended for a more technical audience and shouldn't be part of the main README.