Add beginner-friendly summaries for model package classes #2119
+35
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request adds a new Markdown file named
model-summaries.mdthat contains beginner-friendly explanations for the main classes in themodelpackage:BaseEntity.java: Describes the base class for entities with an auto-generated ID and a method to check if the entity is new.NamedEntity.java: Adds anamefield toBaseEntity, used for entities likePetTypeandSpecialty.Person.java: Represents a person with first and last name fields, extended by classes likeOwnerandVet.package-info.java: Explains the use of@NullMarkedfor null-safety across the package.These summaries are written to help new contributors understand the structure and purpose of these core domain classes.
Closes #2