docs(contributing): route contributions by branch and fix the verify gate#367
Merged
Merged
Conversation
…gate CONTRIBUTING opened by sending every contribution to develop while a later section correctly said 2.0 work targets 2.0-dev — a contradiction that lands an external PR on the wrong branch. Add a branch-routing table up front (2.0 work -> 2.0-dev, critical 1.9.x fixes -> develop, releases -> main) and align the contribution flow with it. Document the blocking gate as the root reactor ./mvnw clean verify (it builds every module now) with -pl :graph-compose-core as the fast engine-only loop.
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.
Why
CONTRIBUTING contradicted itself: the top of the workflow section sent every contribution
to
develop, while the later "Version lines" section correctly says 2.0 work targets2.0-dev.An external contributor reading top-down forks from
developand opens their 2.0 PR against thewrong branch. The documented blocking gate (
./mvnw clean verify) was also described as core-only —true before the layout move, but after it the repository root is the reactor aggregator, so the
same command now builds every module.
What
2.0-dev(almost all currentwork), critical 1.9.x fix →
develop, stable releases →main, after 2.0 GA →develop. Thecontribution steps (
git checkout 2.0-dev, PR against the base you started from) now match it,and the table links to the existing "Version lines" section for the full transition.
./mvnw -B -ntp clean verify(builds every module)with
-pl :graph-compose-coreas the fast engine-only inner loop.aggregator/pom.xml→ the root reactorpom.xml). The release-flow / 2.0-cut prose is rewritten separately with the release runbook.Docs-only; no build or runtime change.
Tests
CanonicalSurfaceGuardTest,DocumentationCoverageTest,PackageMapGuardTest(the guards thatscan CONTRIBUTING for legacy tokens) green. The internal anchor link resolves to the "Version lines"
heading.