Skip to content

README: getting started, how to read, module contents - #85

Merged
mperor merged 1 commit into
masterfrom
PROJECT/readme
Oct 22, 2026
Merged

mperor merged 1 commit into
masterfrom
PROJECT/readme

Conversation

@mperor

@mperor mperor commented Oct 22, 2026 •

Copy link
Copy Markdown
Owner
  • Root README: added Getting Started (JDK 25, running all / one module / one class) and How to Read It (tests as documentation, where to start, what the JavaN headers mean); listed the Common module; the test badge now links to CI runs instead of the JavaReleases test folder.
  • FirstSteps & CleanCode: Check it out pointed to the empty Dummy.java — replaced with a categorized table of contents linking every test (Dummy.java itself left untouched).
  • DesignPatterns: catalog links now lead to the tests (src/test) instead of the implementations, with a note that the implementation sits in the same package under src/main.
  • JavaReleases: each version got a one-line summary of its highlights, based on the class headers and test methods.

All relative links verified to resolve.

…& CleanCode and link patterns to their tests
@github-actions

Copy link
Copy Markdown

Test Results

258 tests  ±0   255 ✅ ±0   5s ⏱️ ±0s
 77 suites ±0     3 💤 ±0 
 77 files   ±0     0 ❌ ±0 

Results for commit 4285102. ± Comparison against base commit 1b151e0.

This pull request skips 1 and un-skips 1 tests.
pl.mperor.lab.java.design.pattern.creational.singleton.SingletonTest ‑ testThreadSafe()
pl.mperor.lab.java.design.pattern.creational.singleton.SingletonTest ‑ testLazyInitialized()

@mperor
mperor merged commit 4a0e3d5 into master Oct 22, 2026
2 checks passed
@mperor
mperor deleted the PROJECT/readme branch October 22, 2026 21:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant