system-prompts-and-models-o.../CONTRIBUTING.md
Claude cb8bb88b4f
refactor: Major repository enhancement v2.0
This commit represents a comprehensive refactor and enhancement of the
entire repository, transforming it from a simple collection to a
searchable, analyzable, and well-documented resource.

## Fixed Issues
- Fixed broken link for Amp directory (./AMp/ → ./Amp/)
- Added missing Emergent and Traycer AI entries to README
- Fixed file extension for Traycer AI/plan_mode_prompts.txt
- Updated line count statistics for accuracy (30,000+ → 25,000+)

## New Infrastructure
- Created scripts/ directory with automation tools
- Added .gitignore for generated files and common artifacts
- Implemented comprehensive metadata system

## New Scripts
- generate_metadata.py: Generate searchable index with tool metadata
- validate.py: Automated repository validation and quality checks
- search.py: Search and filter tools by multiple criteria
- analyze.py: Generate statistics, charts, and comparisons

## Enhanced Documentation
- CONTRIBUTING.md: Comprehensive contribution guidelines
- CHANGELOG.md: Version history and release notes
- README.md: Complete reorganization with categories and search guide
- scripts/README.md: Documentation for all automation tools

## Individual Tool READMEs
- Anthropic/README.md: Claude models documentation
- Cursor Prompts/README.md: Cursor AI system documentation
- Open Source prompts/README.md: Open source tools overview

## Improved Organization
- Reorganized tools by category (IDE, AI Agent, Code Assistant, etc.)
- Added Quick Start section with usage examples
- Added Search & Discovery section
- Better categorization and navigation

## Features
- Searchable metadata index (32 tools, 96 files, 20K+ lines)
- Category-based browsing (11 categories)
- Company and model filtering
- Automated validation checks
- Statistics and analysis tools
- Comparison table generation

## Statistics
- 32 AI tools documented
- 96 total files (76 txt, 15 json, 5 md)
- 20,045 lines of prompts and configuration
- 11 distinct categories
- 4 new Python scripts for automation

Version: 2.0.0
2025-11-15 02:08:32 +00:00

5.1 KiB

Contributing to System Prompts and Models of AI Tools

Thank you for your interest in contributing! This repository is a comprehensive collection of system prompts from AI coding tools and assistants.

🎯 What We're Looking For

New Tools

  • System prompts from AI coding assistants, IDEs, or agents
  • Tool/function definitions (JSON schemas)
  • Official or leaked prompts from production systems
  • Both proprietary and open-source tools

Updates

  • New versions of existing tool prompts
  • Additional files for existing tools
  • Corrections to existing information
  • Metadata improvements

Enhancements

  • Better categorization
  • Improved documentation
  • Analysis scripts
  • Comparison tools

📋 Contribution Guidelines

Adding a New Tool

  1. Create a directory with the tool name:

    Tool Name/
    
  2. Add prompt files:

    • Use descriptive names: Prompt.txt, System Prompt.txt, etc.
    • For multiple prompts: Agent Prompt.txt, Chat Prompt.txt
    • Include version if applicable: Prompt v1.2.txt
  3. Add tool definitions (if available):

    • Use JSON format: Tools.json, Agent Tools.json
    • Include the full schema
  4. Create a README.md in the directory:

    # Tool Name
    
    Brief description of the tool.
    
    ## Contents
    - List of files and what they contain
    
    ## Models Used
    - AI models the tool uses
    
    ## Links
    - Official website
    - Documentation
    
  5. Update the main README.md:

    • Add entry under "Available Files"
    • Keep alphabetical order within categories
  6. Update metadata (if possible):

    • Edit scripts/generate_metadata.py
    • Add tool information to TOOL_INFO dictionary

File Naming Conventions

  • Text files: Use .txt extension
  • JSON files: Use .json extension
  • Documentation: Use .md extension
  • Spaces: Allowed in file names (e.g., Agent Prompt.txt)
  • Versioning: Include version in filename if multiple versions exist

Quality Standards

  1. Completeness: Include the full system prompt, not excerpts
  2. Accuracy: Verify the prompt is current and correctly extracted
  3. Attribution: Note the source, date, and version if known
  4. Privacy: Remove any API keys, secrets, or personal information

Commit Messages

Use clear, descriptive commit messages:

Add Claude Code 2.0 system prompt

- Added new system prompt for Claude Code 2.0
- Includes tool definitions
- Updated README with new entry

Follow conventional commits format:

  • feat: New tool or feature
  • update: Update to existing prompt
  • fix: Corrections or bug fixes
  • docs: Documentation changes
  • refactor: Restructuring without functional changes

🔍 Verification Process

Before submitting:

  1. Run validation:

    python scripts/validate.py
    
  2. Check links:

    • Ensure all README links work
    • Verify directory names match exactly
  3. Test search:

    python scripts/generate_metadata.py
    python scripts/search.py --text "your tool"
    
  4. Format check:

    • Ensure files are UTF-8 encoded
    • Remove trailing whitespace
    • Use consistent line endings (LF)

🚫 What NOT to Submit

  • Incomplete prompts: Partial or fragmentary prompts
  • Fake prompts: Made-up or unverified content
  • Malware: Any malicious code or exploits
  • Copyright violations: Don't submit if legally questionable
  • Spam: Promotional content unrelated to AI tools
  • Personal data: Private API keys, emails, credentials

📊 Metadata Schema

When adding tools to scripts/generate_metadata.py:

"Tool Name": {
    "name": "Display Name",
    "company": "Company Name",
    "category": "Code Assistant|IDE|AI Agent|Web Builder|etc.",
    "type": "proprietary|open-source",
    "description": "Brief description of what it does",
    "website": "https://example.com",
    "models": ["model-1", "model-2"]
}

Categories

  • Code Assistant: AI coding helpers
  • IDE: Integrated development environments
  • AI Agent: Autonomous agents
  • Web Builder: UI/web generation tools
  • Terminal: CLI-based tools
  • Document Assistant: Documentation tools
  • Search Assistant: Search/research tools
  • Foundation Model: Base model prompts

🔄 Update Process

For updating existing tools:

  1. Keep old versions (rename with date/version)
  2. Add new version with clear naming
  3. Update README to note changes
  4. Document what changed in commit message

🤝 Code of Conduct

  • Be respectful and constructive
  • Focus on accuracy and quality
  • Give credit where due
  • Collaborate openly
  • Respect intellectual property
  • Maintain professional standards

📬 Questions?

  • Open an issue for questions
  • Join Discord for discussions
  • Contact maintainer: via GitHub issues

🎁 Recognition

Contributors will be:

  • Listed in commit history
  • Mentioned in release notes
  • Credited for significant additions

📜 License

By contributing, you agree that your contributions will be licensed under the repository's existing license.


Thank you for helping build the most comprehensive collection of AI tool system prompts! 🙏