Skip to content

Add an overview of the JPA example packages. - #717

Open
PotassiumLi wants to merge 1 commit into
spring-projects:mainfrom
PotassiumLi:docs/jpa-example-overview-182
Open

PotassiumLi wants to merge 1 commit into
spring-projects:mainfrom
PotassiumLi:docs/jpa-example-overview-182

Conversation

@PotassiumLi

Copy link
Copy Markdown

The JPA example module contains several independent samples but has no module README to explain their contents. Add a package-to-feature table with links to the existing tests, a starting point for basic repository usage, and the command to run this module's tests.

The overview focuses on Spring Data features, following the scope described in #182.

Validation:

  • JAVA_HOME=<JDK 25> ./mvnw -pl jpa/example -am test -B: 50 tests passed.
  • Checked all 17 relative links and the documented JDK/database requirements against the current sources.
  • git diff --check passed.

Closes #182.

Documentation prepared with AI assistance and checked against the repository sources.

Template checklist:

  • Read the Spring Data contribution guidelines.
  • Formatting: documentation-only change; no Java formatting changes.
  • Validation: existing example tests pass; no runtime behavior changes.
  • Class headers: not applicable; no Java classes changed.

Add a package-to-feature overview with links to the existing JPA example tests and the module test command.

Closes spring-projects#182.

Signed-off-by: 向师晖 <83079697+PotassiumLi@users.noreply.github.com>

Signed-off-by: PotassiumLi <83079697+PotassiumLi@users.noreply.github.com>
@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Oct 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status: waiting-for-triage An issue we've not yet triaged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add readme to jpa/examples to explain the contents

2 participants