Conversation
CONTRIBUTING.md edits (targeted, preserve existing structure): - Add Java 17 baseline section near top — explicit list of Java 21+ APIs / language features to avoid (List.getFirst/getLast, Thread.threadId, switch type/deconstruction patterns, case null+default, List.reversed) so contributors don't get surprised by Linux CI on JDK 17. - Update branch-naming hint to also accept issue-prefixed names like 42/fix/short-description. - Refresh "Required CI checks" list to reflect post-v1.6 reality: JDK 17/21/25 matrix on Build and run tests, plus the new Examples Generation Smoke Test and the PR-only Performance Smoke Check. - Rewrite the Release flow subsection so it matches what cut-release.ps1 actually does today: bumps in *all three* POMs (root + examples + benchmarks), README install snippets intentionally pinned to the previously published tag until JitPack BUILD SUCCESS confirms the new build, tag from develop (not main), post-release commit flips snippets after the publish window closes. - Replace dead test references (BuiltInTemplateRenderTest, CvTemplateV1LayoutSnapshotTest — both deleted with Templates v2 in v1.6.0) with the v2 PresetVisualParityTest / PresetLayoutSnapshotTest pair. - Drop reference to LivePreviewProvider (file no longer in tree). New files (OSS-standard, missing until now): - .github/pull_request_template.md — checklist a contributor sees on every "New PR" page: targets develop, branch convention, Java 17 compat, CHANGELOG entry hint, README guard reminder, examples gallery row count. - .github/ISSUE_TEMPLATE/bug_report.md — repro template with canonical API skeleton + environment block. - .github/ISSUE_TEMPLATE/feature_request.md — use case + proposed API + ADR-worthy gate. - CODE_OF_CONDUCT.md — Contributor Covenant 2.1 verbatim with the maintainer email pointed at the published gmail in pom.xml. Local verification: - ./mvnw -B -ntp test -Dtest='CanonicalSurfaceGuardTest,DocumentationCoverageTest,DocumentationExamplesTest' → 25/0/0/0
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What this is
Brings the contributor-facing docs in line with the post-v1.6.1 reality and adds the standard OSS hygiene files that were missing.
CONTRIBUTING.md updates
List.getFirst/getLast,Thread.threadId(), switch with type / deconstruction patterns,case null, default ->,List.reversed()) so contributors don't get surprised by Linux CI on JDK 17.42/fix/...) — what @jottinger naturally used in Updates module dependencies #11/8/migrate to java 17 #12.Build and run tests, plus the newExamples Generation Smoke Testand the PR-onlyPerformance Smoke Check.cut-release.ps1truth: bumps in all three POMs (root, examples, benchmarks), README install snippets intentionally pinned to the previously published tag until JitPackBUILD SUCCESS(the v1.6.0 lesson), tag from develop, post-release commit flips snippets after the publish window closes.BuiltInTemplateRenderTest,CvTemplateV1LayoutSnapshotTest(both deleted with Templates v2 in v1.6.0),LivePreviewProvider(file no longer present). Replaced with the v2PresetVisualParityTest/PresetLayoutSnapshotTestpair.New files
.github/pull_request_template.md— checklist a contributor sees on every "New PR" page: targetsdevelop, branch naming, Java 17 compat, CHANGELOG entry hint, README guard reminder, examples gallery row count rule..github/ISSUE_TEMPLATE/bug_report.md— repro template with canonical-API skeleton + environment block..github/ISSUE_TEMPLATE/feature_request.md— use case + proposed API + ADR-worthy gate.CODE_OF_CONDUCT.md— Contributor Covenant 2.1, maintainer email points at the published gmail inpom.xml.Verification
Architecture + Documentation guard suite (incl.
DocumentationCoverageTest.contributingGuideShouldRequireCleanVerifyGatewhich scansCONTRIBUTING.md) passes locally:Docs-only change. No source touched.
Closes nothing; sets up the soil for future PRs to land cleanly.