change-module
Skill8.8k starsChanged 2 days agoMITView on GitHub
Fix a bug in, add a feature to, or upgrade the default image of an existing Testcontainers for Java module or core, without breaking the public API. Use for changes under modules/<name>/ or core/.
In this repository4 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- add-moduleSkill
- review-prSkill
The file
We split this skill into the rules it gives an agent
9 rules. About 0 are common, 7 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈7
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 13
Read the existing tests and the module docs page (docs/modules//<name>.md), including which codeinclude markers it uses.
- Distinctive: line 18
Keep the change focused on the issue.
- Very specific: line 19
Public API changes must be additive: Add new methods or overloads.
- Distinctive: line 20
Wait strategy changes: keep the overall startup timeout as one budget (don't give each sub-wait the full timeout), and make sure the …
- Distinctive: line 27
Check the image's release notes for changed ports, env vars, startup log lines or health endpoints, and adjust the wait strategy if needed.
- Distinctive: line 28
If older versions behave differently, keep them working (branch on the parsed version only when unavoidable) and keep a test for the oldest …
- Distinctive: line 29
Don't open PRs that only bump a client library version.
- Distinctive: line 38
If you changed core, also run the tests of one or two modules that depend on the changed behaviour.
- Distinctive: line 42
Update the module docs page if behaviour or options changed.
≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Fix, extend or upgrade an existing module
Read AGENTS.md first.
1. Understand the current behaviour
- Find the container class in
modules/<name>/src/main/java/org/testcontainers/<name>/. Check whether a deprecated twin exists inorg.testcontainers.containers; a change usually belongs in the new package, and the deprecated class should keep working. - Read the existing tests and the module docs page (
docs/modules/**/<name>.md), including which codeinclude markers it uses. - For a bug, write a failing test first that reproduces the reported behaviour.
2. Make the change
- Keep the change focused on the issue. Don't reformat unrelated code (Spotless will handle formatting).
- Public API changes must be additive. Add new methods or overloads. To replace something, deprecate it with
@Deprecatedand a Javadoc@deprecated use {@link ...}pointer. Don't change existing signatures, return types or visibility;japicmpincheckfails on that. - Wait strategy changes: keep the overall startup timeout as one budget (don't give each sub-wait the full timeout), and make sure the strategy works for every image tag the module claims to support.
- Validate new
withXxx(...)arguments and fail with a clear message. - Main code stays Java 8 compatible.
3. Upgrading the default or tested image version
- Users always pass an explicit image, so an "upgrade" usually means updating the tags used in tests and docs. Some database modules keep a
DEFAULT_TAGused by their JDBC/R2DBC container providers; changing it changes behaviour forjdbc:tc:URL users, so call that out in the PR. - Check the image's release notes for changed ports, env vars, startup log lines or health endpoints, and adjust the wait strategy if needed.
- If older versions behave differently, keep them working (branch on the parsed version only when unavoidable) and keep a test for the oldest supported behaviour where practical.
- Don't open PRs that only bump a client library version; Dependabot does that.
4. Verify
./gradlew spotlessApply
./gradlew :testcontainers-<name>:check # or :testcontainers:check for coreIf you changed core, also run the tests of one or two modules that depend on the changed behaviour.
5. Docs and PR
- Update the module docs page if behaviour or options changed; prefer codeinclude from tests.
- In the PR, describe the broken behaviour and how the change fixes it, and reference the issue (
Fixes #<number>).
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

