dashorst opened a new pull request, #28:
URL: https://github.com/apache/wicket-site/pull/28

   The contributor pages for Wicket's own code were written for Wicket 6: a 
clone from `git-wip-us.apache.org`, JDK 6, `mvn eclipse:eclipse`, 
`-Dmaven.test.skip=true`, an Eclipse formatter file in `wicket-core` that does 
not exist, and TravisCI. The pull request page listed the end-of-life 
`wicket-9.x` and `wicket-8.x` branches and left out `wicket-11.x`. None of them 
mentioned that most tests live in another module than the code, so a targeted 
Maven test run uses whatever jar was installed last.
   
   This replaces them with a DiƔtaxis set in the `_contribute` collection, 
written for first-time contributors such as Google Summer of Code students 
picking up the `good first issue` tickets (apache/wicket#1945). CONTRIBUTING.md 
in apache/wicket holds the rules and links to four of these pages; the site 
holds everything that teaches or explains.
   
   Preview: https://dashorst.github.io/wicket-site/current/contribute/
   
   | Page | Kind | |
   |---|---|---|
   | [Your first pull 
request](https://dashorst.github.io/wicket-site/current/contribute/wicket-first-pull-request.html)
 | Tutorial | New. Issue apache/wicket#1950 from claim to pull request: a 
failing test, the one-line fix, and the test run that keeps failing until 
`wicket-request` is installed. |
   | [Send a pull request to 
Wicket](https://dashorst.github.io/wicket-site/current/contribute/wicket-pull-request.html)
 | How-to | Rewritten, absorbs `patch.md`. Claiming an issue, branching from 
`master`, building, testing, commit message, review. |
   | [Build and test 
Wicket](https://dashorst.github.io/wicket-site/current/contribute/wicket-build.html)
 | How-to | Replaces `build.md`. One test in a `-tests` module, JavaScript 
tests, the examples, the full build, common failures. |
   | [Set up your 
IDE](https://dashorst.github.io/wicket-site/current/contribute/wicket-ide.html) 
| How-to | Replaces `ides.md`. IntelliJ IDEA, Eclipse, VS Code, NetBeans; 
whether a test run from each needs an install; no format-on-save. |
   | [Code 
conventions](https://dashorst.github.io/wicket-site/current/contribute/wicket-conventions.html)
 | Reference | New. Format, license header, tests, Javadoc and `@since`, API 
changes, poms, commits. |
   | [Why most tests live in another 
module](https://dashorst.github.io/wicket-site/current/contribute/wicket-test-modules.html)
 | Explanation | New. `WicketTester` depends on `wicket-core`, hence 
`wicket-core-tests`, and the install trap that follows. |
   | [Why fixes go to master 
first](https://dashorst.github.io/wicket-site/current/contribute/wicket-master-first.html)
 | Explanation | New. Cherry-picking down, who decides, why Wicket's branches 
are never rewritten. |
   | [API 
compatibility](https://dashorst.github.io/wicket-site/current/contribute/wicket-api-compatibility.html)
 | Explanation | New. japicmp's baseline is the `.0.0` release of the branch's 
line, so it only checks the release branches. |
   | [Wicket's security 
model](https://dashorst.github.io/wicket-site/current/contribute/wicket-security-model.html)
 | Explanation | New. What the framework promises and what it trusts; points to 
SECURITY.md. |
   
   ## For review
   
   - **Core:** the nine `_contribute/wicket-*.md` pages, and 
`contribute/index.md`, whose intro now points first-timers to the tutorial.
   - **Redirects:** `.htaccess` sends `/contribute/build.html`, `ides.html` and 
`patch.html` to their new pages; `patch.html#reportbug` and `#github` keep 
working.
   - **Data-driven:** the branch table and every release line name come from 
`_data/releases.yml`, so they follow release day without an edit. Versions of 
Java, Maven, Node and Chrome, and the JavaScript test setup, are linked to 
README.md, the GitHub workflow and JAVASCRIPTTESTING.md instead of copied, 
because the site is not versioned per branch.
   - **Squashing:** the pages ask for focused commits with review fixes 
squashed before the merge, and leave open whether the contributor or the 
merging committer squashes, as CONTRIBUTING.md does until dev@ decides.
   - **Mechanical:** the three "Build the site into content/" commits. Outside 
`content/contribute/` they only change the `?v=` cache-busters.
   
   ## Merge order
   
   The pages link to `CONTRIBUTING.md` in apache/wicket, which is not merged 
yet and returns 404 until it is. Merge this after the CONTRIBUTING.md change 
lands, since the site goes live with the merge.
   
   ## Open points
   
   - The tutorial spells out the fix for apache/wicket#1950, so that issue is 
effectively reserved for it, and the tutorial goes stale once its fix is merged.
   - The IDE steps were not tried in an IDE: the IntelliJ and Eclipse menu 
paths, the VS Code launch configuration and the NetBeans install note (hedged 
as "probably") are unverified.
   - Windows was not tried; line endings may affect tests that compare expected 
HTML.
   
   ## Tested
   
   Every command on the build and pull request pages was run as written in a 
fresh clone of apache/wicket `master` with an empty local Maven repository, and 
the tutorial's steps 4 to 6 were run as written: the new test fails, still 
fails after the fix until `wicket-request` is installed, then passes with the 
other 51 tests of `UrlRendererTest`. The fast build, the `-am` variant, the 
JavaScript tests, `mvn jetty:run -pl wicket-examples` and the full `mvn clean 
verify -Pjs-test` pass. One exception: `OsgiClashingPackagesTest` fails when 
the path to the local Maven repository contains `wicket-`, because it filters 
jars on the whole path; that is a bug in the test, not in these pages. Jekyll 
build: all links between the contribute pages and their anchors resolve.
   
   šŸ¤– Generated with [Claude Code](https://claude.com/claude-code)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to