Contributing to Claude Code Configs

Contributing to Claude Code Configs

Thank you for your interest in contributing to Claude Code Configs! This project thrives on community contributions, and we welcome configs for new frameworks, improvements to existing configurations, and enhancements to the CLI tool.

📋 Table of Contents

• Code of Conduct
• How to Contribute
• Adding a New Configuration
• Improving Existing Configurations
• Contributing to the CLI Tool
• Testing Guidelines
• Pull Request Process

Code of Conduct

Please be respectful and constructive in all interactions. We aim to maintain a welcoming and inclusive community.

How to Contribute

1. Fork and Clone

# Fork the repository on GitHub, then:
git clone https://github.com/YOUR-USERNAME/claude-code-configs.git
cd claude-code-configs

2. Create a Branch

git checkout -b feature/your-feature-name

3. Make Your Changes

See specific sections below for different types of contributions.

4. Test Your Changes

cd claude-config-composer
npm install
npm test
npm run build

5. Submit a Pull Request

Push your branch and create a PR against the `main` branch.

Adding a New Configuration

Structure Requirements

Create your configuration in the appropriate category:

configurations/
├── frameworks/     # React, Vue, Angular, etc.
├── ui/            # Component libraries, CSS frameworks
├── databases/     # ORMs, database tools
├── tooling/       # Build tools, SDKs
└── mcp-servers/   # MCP server implementations

Required Files

Each configuration must include:

your-config/
├── .claude/
│   ├── settings.json      # Permissions and environment variables
│   ├── agents/            # Specialized AI agents (optional)
│   ├── commands/          # Custom commands (optional)
│   └── hooks/            # Automation hooks (optional)
├── CLAUDE.md              # Main configuration and best practices
├── README.md              # Setup and usage instructions
└── package.json           # Metadata and version info

package.json Format

{
  "name": "@claude-code-configs/your-config",
  "version": "1.0.0",
  "description": "Brief description of your configuration",
  "keywords": ["claude-code", "your-framework"],
  "claude-config": {
    "category": "frameworks|ui|databases|tooling|mcp-servers",
    "priority": 10,
    "compatibility": {
      "requires": [],
      "conflicts": []
    }
  }
}

CLAUDE.md Guidelines

Your CLAUDE.md should include:

1. Project Context - What this configuration is for
2. Core Technologies - List of main dependencies
3. Security Best Practices - Security considerations
4. Development Patterns - Framework-specific patterns
5. Testing Approach - How to test code
6. Resources - Links to docume