add-module
Skill8.8k starsChanged 2 days agoMITView on GitHub
Add a new Testcontainers for Java module for a technology (new container class, tests, docs and repo registration). Use when asked to create or contribute a new module under modules/.
10 other projects use a version of this.
Adopted by
Most recently taken up by
- helmut-hoffer-von-ankershoffen/heinzeltheir own version, first seen Nov 8, 2026
- heytcass/claudeostheir own version, first seen Oct 29, 2026
- Cassius2584/claude-uni-workspacetheir own version, first seen Oct 22, 2026
- testcontainers/testcontainers-nodetheir own version, first seen Oct 17, 2026
- ai-erp-collab/deterministic-context-routing-plugintheir own version, first seen Oct 15, 2026
- shubhsha/ai-engineer-2030their own version, first seen Oct 15, 2026
Other versions10 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 10
- fullstackhero/dotnet-starter-kit★ 6.9ksame name
- testcontainers/testcontainers-node★ 2.6ksame name
- Cassius2584/claude-uni-workspace★ 5same name
- helmut-hoffer-von-ankershoffen/heinzel★ 2same name
- serhii12/vault-os★ 2same name
- AURORA-NEURO/aurora-agent★ 1same name
- heytcass/claudeos★ 1same name
- ai-erp-collab/deterministic-context-routing-plugin★ 0same name
- alimranfakir/Claude_skills★ 0same name
- shubhsha/ai-engineer-2030★ 0same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository4 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- change-moduleSkill
- review-prSkill
The file
We split this skill into the rules it gives an agent
8 rules. 0 are common, 3 are distinctive, and 5 are very specific to this project.
0
Common
Most of the 9 edited versions we read keep these.
3
Distinctive
This author's own choices. Worth a look.
5
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 8
Read AGENTS.md first; this playbook only adds the module-specific steps.
- Very specific: line 18
If not, suggest an example under examples/ or a third-party library instead, and stop.
- Distinctive: line 20
Check the default image too: an official Docker Hub image or one published by the vendor, with a public Dockerfile, immutable version tags, …
- Very specific: line 49
Use modules/typesense/src/main/java/org/testcontainers/typesense/TypesenseContainer.java as the reference shape:
- Very specific: line 76
Create docs/modules/<name>.md (or docs/modules/databases/<name>.md), following docs/modules/typesense.md: overview, codeinclude usage …
- Very specific: line 77
Add the incubating note at the top (text in docs/contributing.md, "Incubating modules").
- Very specific: line 78
Add the page to the nav in mkdocs.yml, keeping alphabetical order within its section.
- Distinctive: line 82
Add the module, keeping alphabetical order, to:
“Common” is measured: kept by at least 6 in 10 of the 9 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Add a new module
Read AGENTS.md first; this playbook only adds the module-specific steps.
0. Check it should be a module
New modules need maintainer buy-in before significant work (see "Contributing new modules" in
docs/contributing.md). Confirm with the person you are working for that:
- there is an issue or discussion where maintainers agreed to the module, and
- it adds value beyond a
GenericContainersnippet (technology-specific wait strategy, non-trivial setup, client helpers).
If not, suggest an example under examples/ or a third-party library instead, and stop.
Check the default image too: an official Docker Hub image or one published by the vendor, with a public Dockerfile, immutable version tags, and a license that lets anyone pull and use it.
1. Create the Gradle project
settings.gradle includes every directory under modules/ automatically as :testcontainers-<name>.
modules/<name>/
build.gradle
src/main/java/org/testcontainers/<name>/<Name>Container.java
src/test/java/org/testcontainers/<name>/<Name>ContainerTest.java
src/test/resources/logback-test.xml # copy from an existing moduleMinimal build.gradle (see modules/typesense/build.gradle):
description = "Testcontainers :: <Display Name>"
dependencies {
api project(':testcontainers')
// compileOnly 'vendor:client:x.y.z' // optional, for internal use in main code; never expose its types in public API
testImplementation 'vendor:client:x.y.z'
}2. Write the container class
Use modules/typesense/src/main/java/org/testcontainers/typesense/TypesenseContainer.java as the reference shape:
DEFAULT_IMAGE_NAME = DockerImageName.parse("<vendor>/<image>")without a tag.- Constructors
(String)and(DockerImageName); the second callsdockerImageName.assertCompatibleWith(DEFAULT_IMAGE_NAME). withExposedPorts(...)and a technology-specificwaitingFor(...).- Configuration via
withXxx(...)methods returningthis; validate inputs. Apply env/commands inconfigure()when they depend on settings. - Getters for everything a client needs (endpoint URL, mapped ports, credentials).
- Class Javadoc listing the supported image and exposed ports.
- Java 8 source level, JDK types only in public API.
3. Write tests
- Pin an explicit image tag, e.g.
new <Name>Container("<vendor>/<image>:1.2.3"). - Cover default startup with a real client call and each
withXxxoption. - Wrap the snippet you want in the docs with
// container {and// }.
Run:
./gradlew spotlessApply
./gradlew :testcontainers-<name>:checkjapicmp is skipped automatically for a module that has no released version yet.
4. Documentation
- Create
docs/modules/<name>.md(ordocs/modules/databases/<name>.md), followingdocs/modules/typesense.md: overview, codeinclude usage example, dependency block with{{latest_version}}. - Add the incubating note at the top (text in
docs/contributing.md, "Incubating modules"). - Add the page to the
navinmkdocs.yml, keeping alphabetical order within its section.
5. Register the module in repo metadata
Add the module, keeping alphabetical order, to:
.github/ISSUE_TEMPLATE/bug_report.yaml(module dropdown).github/ISSUE_TEMPLATE/enhancement.yaml.github/ISSUE_TEMPLATE/feature.yaml.github/dependabot.yml: add/modules/<name>to the "Modules without additional compatibility constraints" entry, unless it needs its own ignore rules.github/labeler.yml: amodules/<name>label matchingmodules/<name>/**/*
6. Open the PR
Paste the "Checklist" from docs/contributing.md into the PR description and tick what applies. Link the issue or discussion where the module was agreed.
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.

