Contributing to AI Tools

Thank you for your interest in contributing to the AI Tools repository! This guide will help you get started.

📝 Commit Conventions

We use Conventional Commits to maintain a clean git history and enable automatic changelog generation.

Quick Format:

<type>[optional scope]: <description>

Example:

feat(prompts): add code review prompt for Python

See the full Conventional Commits Guide for details.

📋 Contributing Process

  1. Fork & Clone: Fork the repository and clone it locally
  2. Create Branch: Create a feature branch from main
  3. Make Changes: Add or update content following our standards
  4. Test Locally: Run Jekyll locally to verify your changes
  5. Commit: Use conventional commit messages
  6. Push & PR: Push to your fork and create a pull request

📚 Content Types

Prompts

Located in _prompts/, organized by category (coding, writing, analysis, etc.)

Instructions

Located in _instructions/, step-by-step guides and procedures

Modes

Located in _modes/, AI interaction configurations

Thoughts

Located in _thoughts/, personal reflections and experiments

✅ Quality Standards

  • Clear and Concise: Write for your audience
  • Well-Organized: Use appropriate categories and tags
  • Tested: Verify prompts and instructions work as expected
  • Documented: Include examples and usage notes
  • Maintained: Keep content up-to-date

💬 Getting Help

If you have questions or need help:

  • Review existing content for examples
  • Check the documentation
  • Open an issue for discussion