Skip to content

Commit b99799d

Browse files
Copilotmdelapenya
Copilot
and
mdelapenya
committed
Add comprehensive README for testcontainers/claude-skills repository
Co-authored-by: mdelapenya <951580+mdelapenya@users.noreply.github.com>
1 parent 71c6c09 commit b99799d

1 file changed

Lines changed: 145 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
# Testcontainers Skills for Claude
2+
3+
Skills are folders of instructions, scripts, and resources that Claude loads dynamically to improve performance on specialized tasks. This repository contains Testcontainers-related skills that teach Claude how to work with container-based testing and infrastructure.
4+
5+
For more information about skills, check out:
6+
- [What are skills?](https://support.claude.com/en/articles/12512176-what-are-skills)
7+
- [Using skills in Claude](https://support.claude.com/en/articles/12512180-using-skills-in-claude)
8+
- [How to create custom skills](https://support.claude.com/en/articles/12512198-creating-custom-skills)
9+
- [Equipping agents for the real world with Agent Skills](https://anthropic.com/engineering/equipping-agents-for-the-real-world-with-agent-skills)
10+
- [Main skills repository](https://github.com/anthropics/skills) - Upstream repository with example skills
11+
12+
## About This Repository
13+
14+
This repository contains Testcontainers-related skills for Claude. These skills help Claude work more effectively with container-based testing infrastructure, particularly focusing on integration testing patterns using Docker containers.
15+
16+
Each skill is self-contained in its own directory with a `SKILL.md` file containing the instructions and metadata that Claude uses.
17+
18+
The skills in this repository are open source under the MIT License.
19+
20+
## Disclaimer
21+
22+
**These skills are provided for demonstration and educational purposes only.** While some of these capabilities may be available in Claude, the implementations and behaviors you receive from Claude may differ from what is shown in these examples. These examples are meant to illustrate patterns and possibilities. Always test skills thoroughly in your own environment before relying on them for critical tasks.
23+
24+
## Available Skills
25+
26+
### testcontainers-go
27+
A comprehensive guide for using Testcontainers for Go to write reliable integration tests with Docker containers in Go projects. This skill provides:
28+
29+
- Support for 62+ pre-configured modules for databases, message queues, cloud services, and more
30+
- Best practices for setting up and managing Docker containers in Go tests
31+
- Configuration guidance for networking, volumes, and environment variables
32+
- Proper cleanup and resource management patterns
33+
- Debugging and troubleshooting techniques
34+
35+
**Key capabilities:**
36+
- Use pre-configured modules (PostgreSQL, Redis, Kafka, MySQL, MongoDB, and more)
37+
- Write integration tests with real services instead of mocks
38+
- Test against multiple versions or configurations of dependencies
39+
- Create reproducible test environments
40+
- Set up ephemeral test infrastructure
41+
42+
See the [testcontainers-go skill documentation](./testcontainers-go/SKILL.md) for detailed usage instructions and examples.
43+
44+
## Try in Claude Code, Claude.ai, and the API
45+
46+
### Claude Code
47+
You can register this repository as a Claude Code Plugin marketplace by running the following command in Claude Code:
48+
```
49+
/plugin marketplace add testcontainers/claude-skills
50+
```
51+
52+
Then, to install the testcontainers-go skill:
53+
1. Select `Browse and install plugins`
54+
2. Select `testcontainers-claude-skills`
55+
3. Select `testcontainers-go`
56+
4. Select `Install now`
57+
58+
Alternatively, directly install the plugin via:
59+
```
60+
/plugin install testcontainers-go@testcontainers-claude-skills
61+
```
62+
63+
After installing the plugin, you can use the skill by just mentioning it. For instance: "Use the testcontainers-go skill to help me write an integration test for PostgreSQL"
64+
65+
### Claude.ai
66+
67+
To use any skill from this repository or upload custom skills, follow the instructions in [Using skills in Claude](https://support.claude.com/en/articles/12512180-using-skills-in-claude#h_a4222fa77b).
68+
69+
### Claude API
70+
71+
You can upload custom skills via the Claude API. See the [Skills API Quickstart](https://docs.claude.com/en/api/skills-guide#creating-a-skill) for more.
72+
73+
## Creating a Basic Skill
74+
75+
Skills are simple to create - just a folder with a `SKILL.md` file containing YAML frontmatter and instructions. Here's a basic template:
76+
77+
```markdown
78+
---
79+
name: my-skill-name
80+
description: A clear description of what this skill does and when to use it
81+
license: MIT
82+
---
83+
84+
# My Skill Name
85+
86+
[Add your instructions here that Claude will follow when this skill is active]
87+
88+
## Description
89+
90+
Detailed explanation of the skill's capabilities.
91+
92+
## When to Use This Skill
93+
94+
- Use case 1
95+
- Use case 2
96+
- Use case 3
97+
98+
## Instructions
99+
100+
Step-by-step guidance on how to use the skill.
101+
102+
## Examples
103+
104+
Example code and usage patterns.
105+
106+
## Best Practices
107+
108+
Guidelines and recommendations.
109+
```
110+
111+
The frontmatter requires:
112+
- `name` - A unique identifier for your skill (lowercase, hyphens for spaces)
113+
- `description` - A complete description of what the skill does and when to use it
114+
- `license` - (Optional) License for the skill content
115+
116+
The markdown content below contains the instructions, examples, and guidelines that Claude will follow. For more details, see [How to create custom skills](https://support.claude.com/en/articles/12512198-creating-custom-skills).
117+
118+
## Contributing
119+
120+
Contributions are welcome! If you have a Testcontainers-related skill that would benefit the community:
121+
122+
1. Fork this repository
123+
2. Create a new directory for your skill
124+
3. Add a `SKILL.md` file with proper frontmatter and instructions
125+
4. Submit a pull request with a clear description of the skill
126+
127+
Please ensure your skill:
128+
- Follows the structure and format of existing skills
129+
- Includes clear documentation and examples
130+
- Is specific to Testcontainers or container-based testing
131+
- Is licensed under MIT or a compatible open source license
132+
133+
## License
134+
135+
This repository is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
136+
137+
## Related Projects
138+
139+
- [Testcontainers for Go](https://github.com/testcontainers/testcontainers-go) - The main Testcontainers for Go library
140+
- [Testcontainers](https://testcontainers.com/) - Official Testcontainers website
141+
- [Anthropic Skills](https://github.com/anthropics/skills) - Main skills repository with additional examples
142+
143+
## Acknowledgments
144+
145+
This repository is inspired by and follows the structure of the [Anthropic Skills repository](https://github.com/anthropics/skills). The testcontainers-go skill was originally contributed to the main skills repository in [PR #73](https://github.com/anthropics/skills/pull/73) and is maintained here as a Testcontainers-focused collection.

0 commit comments

Comments
 (0)