Contributing to Developer Kit for Claude Code
March 16, 2026 ยท View on GitHub
Thank you for your interest in contributing! This document provides guidelines and instructions for contributing to the Developer Kit for Claude Code.
๐ฏ What You Can Contribute
The Developer Kit welcomes contributions in the following areas:
1. New Skills ๐
Add reusable capabilities for Claude Code covering:
- Java/Spring Boot patterns (expanded scope beyond existing)
- New languages: PHP, TypeScript, Python, Go, Rust, etc.
- New frameworks: Django, FastAPI, Laravel, Express, etc.
- Specialized domains: Cloud providers (AWS, GCP, Azure), data processing, DevOps, etc.
2. Skill Improvements โจ
Enhance existing skills with:
- Additional examples and use cases
- Better explanations or clearer documentation
- New best practices and patterns
- Performance or security improvements
- Supporting scripts or utilities
3. Agents ๐ค
Create specialized AI assistants for:
- Domain-specific code reviews
- Language or framework specialists
- Testing and debugging automation
- Security and performance analysis
4. Slash Commands โก
Add quick-access commands for:
- Common development tasks
- Workflow automation
- Project-specific shortcuts
5. Documentation ๐
Improve project documentation:
- README updates with new capabilities
- Architecture documentation
- Troubleshooting guides
- Integration guides
6. Bug Fixes & Issues ๐
- Report issues with existing skills
- Fix documentation errors
- Improve examples or code samples
- Suggest enhancements
๐ Before You Start
- Check existing content: Search existing components in plugins/ to avoid duplicating skills, agents, or commands
- Open an issue: For significant changes, discuss your idea first by opening an issue
- Understand the structure: Review the project organization and existing patterns
๐ Creating a New Skill
Directory Structure
skills/[category]/[skill-name]/
โโโ SKILL.md # Required: Skill metadata and instructions
โโโ reference.md # Optional: Detailed API reference
โโโ examples.md # Optional: Practical examples
โโโ scripts/ # Optional: Helper scripts (Python, Bash, etc.)
โ โโโ validator.py
โ โโโ processor.sh
โโโ templates/ # Optional: Templates and boilerplate
โโโ sample.txt
SKILL.md Format
---
name: skill-descriptive-name
description: Brief description of what this skill does and when to use it. Include trigger keywords (max 1024 chars). Should mention BOTH capabilities AND use cases.
allowed-tools: Read, Write, Bash # Optional: restrict tool access
---
# Skill Name
## When to Use
- Clear trigger phrases and context where this skill applies
- Specific use cases and scenarios
- What problems it solves
## Instructions
- Step-by-step guidance for using this skill
- Key concepts and terminology
- Common patterns and approaches
## Examples
- Basic example with expected output
- Intermediate example showing more features
- Advanced example with best practices
- Real-world use cases
## Best Practices
- Key principles and guidelines
- Common pitfalls to avoid
- Performance considerations
- Security considerations
- Integration with related skills
## Related Skills
- Links to complementary skills
- When to use instead of this skill
- How skills work together
Creating a Skill - Step by Step
-
Create the directory:
mkdir -p skills/[category]/[skill-name] -
Create SKILL.md with required frontmatter:
name: lowercase, hyphens (no spaces)description: Specific, includes trigger keywords, states both what AND when
-
Add supporting files as needed:
reference.md: Technical specifications, APIs, configurationsexamples.md: Practical, runnable examples progressing from basic to advancedscripts/: Helper utilities (Python, Bash, JavaScript)
-
Follow content guidelines:
- Target audience: Developers using Claude Code for that domain
- Include both Maven and Gradle configs for Java/Spring Boot skills
- Code samples follow best practices from the domain
- Examples should be copy-paste ready
- Performance guidelines where applicable
-
Test your skill:
- Ask Claude questions matching your description
- Verify Claude discovers and uses the skill appropriately
- Test with various use cases and edge cases
Skill Content Guidelines
Structure:
- Keep SKILL.md focused on instructions (~200-400 lines)
- Use supporting files for extensive reference material
- Progressive disclosure: advanced topics in separate files
- Clear section hierarchy (H2 for main sections, H3 for subsections)
Examples:
- Show progression: simple โ complex
- Include actual outputs/results
- Provide context for each example
- Use realistic data and scenarios
- For framework skills: include both Maven and Gradle
Best Practices:
- Language-specific conventions (Java vs Python vs TypeScript)
- Security considerations for the domain
- Performance guidelines and benchmarks
- SOLID principles where applicable
- Common anti-patterns to avoid
- Integration points with other tools/skills
Documentation:
- Assume reader has basic domain knowledge
- Define specialized terminology
- Link to related skills
- Include references to official documentation
- Credit sources and inspiration
๐ค Creating a New Agent
Directory Structure
agents/[agent-name].md
Agent File Format
---
name: agent-name
description: Natural language description of when this agent should be used. Include specific use cases and trigger keywords.
tools: Read, Bash, Edit # Optional: comma-separated. Omit to inherit all tools.
model: sonnet # Optional: sonnet, opus, haiku, or inherit
---
# Agent Name
You are a [specific role] expert. Your responsibilities include:
- Specific capability 1
- Specific capability 2
- Specific capability 3
## When to Use
- Clear trigger conditions
- Use cases and scenarios
- What problems it solves
- When NOT to use this agent
## Process
1. First step: Initial analysis or gathering information
2. Analysis: Investigation and understanding
3. Implementation: Action and solution
4. Verification: Testing and confirmation
## Guidelines
- Best practices for this domain
- Constraints and limitations
- Error handling and edge cases
- When to escalate back to main thread
- Performance considerations
## Example Workflow
Provide a concrete example showing typical usage
Agent Guidelines
- Specific description with trigger keywords (not generic)
- Single responsibility focused on one domain
- Tool restrictions for security and focus (omit tools: field to inherit all)
- Detailed process with clear workflow steps
- Include "proactively" in description if agent should auto-detect usage
- Comprehensive guidelines covering edge cases
โก Creating a Slash Command
File Structure
commands/[category/]command-name.md
Command Format
---
description: Brief command description for /help
allowed-tools: Bash(git:*), Read, Edit
argument-hint: [arg1] [arg2] [arg3]
---
## Command Description
Clear explanation of what the command does.
Use \$1, \$2, \$3 for positional arguments.
Use $ARGUMENTS for all arguments combined.
Include bash execution with ! prefix to run commands:
!echo "Current branch: $(git branch --show-current)"
Result:
Include expected output here.
Command Guidelines
- Keep it simple and single-purpose
- Clear argument hints for autocomplete
- Restrict tools to only what's needed
- Use bash execution (!) for dynamic context
- Document expected behavior and output
๐ Contributing Documentation
README Updates
- Keep main README current with new capabilities
- Update tables of contents as needed
- Add new skills/agents to appropriate sections
Architecture Documentation
- Explain patterns and design decisions
- Provide diagrams where helpful
- Document integration points
Bug Reports and Fixes
- Include concrete examples and reproduction steps
- Propose solutions when possible
- Reference related issues or PRs
โ Quality Standards
For Skills
- โ Specific, discoverable description with trigger keywords
- โ Clear "When to Use" section explaining context
- โ Practical examples with expected output
- โ Best practices section with domain insights
- โ All file paths use forward slashes (Unix style)
- โ No hardcoded credentials or secrets
- โ Proper formatting and clear structure
- โ Links to related skills where applicable
- โ ~300 lines max per file (use supporting files for expansion)
For Agents
- โ Detailed role description and responsibilities
- โ Clear process/workflow with numbered steps
- โ Specific trigger conditions and use cases
- โ Tool restrictions appropriate for the role
- โ Comprehensive guidelines including edge cases
- โ Include "proactively" if auto-detection desired
For Commands
- โ Simple, focused purpose (single file)
- โ Clear argument hints and description
- โ Tool restrictions for security
- โ Example usage with expected output
For Documentation
- โ Clear, concise writing
- โ Proper Markdown formatting
- โ Links to relevant resources
- โ Examples where helpful
๐ Submission Process
1. Fork and Clone
git clone https://github.com/your-username/developer-kit-claude-code.git
cd developer-kit-claude-code
2. Create a Feature Branch
git checkout -b feat/your-skill-name
# or
git checkout -b fix/issue-description
# or
git checkout -b docs/improvement-description
3. Make Your Changes
- Follow the guidelines above for your contribution type
- Test thoroughly before submitting
- Ensure YAML/JSON syntax is valid
- Verify file paths are correct
4. Commit with Clear Messages
git commit -m "feat: add spring-boot-caching skill"
git commit -m "fix: improve spring-boot-actuator examples"
git commit -m "fix: fixed typo in REST API standards"
git commit -m "docs: update README with new skills"
5. Push to Your Fork
git push origin feat/your-skill-name
6. Create a Pull Request
- Describe what you're adding/fixing
- Link related issues (if any)
- Provide context for reviewers
- Include examples of the skill/agent in action
๐ Learning From Existing Content
Study these examples to understand project conventions:
Spring Boot Skills
- spring-boot-actuator - Full-featured skill with supporting files
- spring-boot-crud-patterns - Architecture patterns
- spring-boot-dependency-injection - Best practices focus
JUnit Test Skills
- JUnit test guide - Comprehensive testing patterns
LangChain4j Skills
- LangChain4j guide - AI integration patterns
Existing Agents
- spring-boot-code-review-expert - Example agent
๐ Reporting Issues
When reporting issues, include:
- Clear title: What's the problem?
- Description: Context and impact
- Steps to reproduce: How to see the issue
- Expected behavior: What should happen
- Actual behavior: What happens instead
- Suggested fix: Ideas for resolution (if applicable)
๐ฌ Questions or Feedback?
- Open an issue for discussions
- Use GitHub Discussions for broader topics
- Check existing issues before creating new ones
๐ License
By contributing, you agree that your contributions will be licensed under the same license as this project (see LICENSE).
๐ Thank You!
Thank you for contributing to making Claude Code more powerful and useful for developers everywhere!
Last updated: October 2024