Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
241 lines (177 loc) · 6.81 KB

CONTRIBUTING.md

File metadata and controls

241 lines (177 loc) · 6.81 KB
Raw

Contributing to Taming Technology: AI Learning Orchestration

Thank you for your interest in contributing to the AI Learning Orchestration system! This guide will help you get started.

🎯 What We're Looking For

We welcome contributions in these areas:

📚 Content Contributions

  • Domain Adaptations - Customize the system for Data Science, Mobile Dev, Game Dev, Design, etc.
  • Workflow Patterns - Document new AI orchestration patterns you've discovered
  • Success Stories - Share your learning journey and results
  • Tool Updates - Keep the AI Tool Matrix current with new tools and capabilities
  • Prompt Improvements - Enhance the three core prompts based on real-world use

🔧 Technical Contributions

  • Quick Reference Cards - Create printable/shareable decision aids
  • Companion Tools - Build Notion templates, VSCode extensions, browser tools
  • Scripts & Automation - Tools to help with the orchestration workflow
  • Translations - Help make this accessible to non-English speakers

📖 Documentation

  • Tutorials & Walkthroughs - Video or written guides
  • Examples & Case Studies - Real-world applications
  • FAQ Additions - Common questions and answers
  • Troubleshooting Guides - Solutions to common problems

🚀 How to Contribute

1. Small Changes (Typos, Links, Minor Updates)

For small fixes, you can:

  1. Click the "Edit" button on any file in GitHub
  2. Make your changes
  3. Submit a Pull Request
  4. We'll review and merge quickly!

2. Larger Contributions (New Content, Features)

For substantial contributions:

Step 1: Fork & Clone

# Fork this repository on GitHub
# Then clone your fork
git clone https://github.com/YOUR-USERNAME/TamingTechnology.git
cd TamingTechnology

Step 2: Create a Branch

git checkout -b feature/your-feature-name
# Examples:
# git checkout -b feature/data-science-adaptation
# git checkout -b feature/new-workflow-pattern
# git checkout -b fix/typo-in-readme

Step 3: Make Your Changes

  • Follow the existing file structure and naming conventions
  • Use clear, accessible language
  • Include examples where helpful
  • Test any code or scripts

Step 4: Commit Your Changes

git add .
git commit -m "Add: [clear description of what you added]"
# Examples:
# git commit -m "Add: Data Science domain adaptation guide"
# git commit -m "Update: AI Tool Matrix with new tools"
# git commit -m "Fix: Broken links in README"

Step 5: Push & Create Pull Request

git push origin feature/your-feature-name

Then open a Pull Request on GitHub with:

  • Clear title describing the change
  • Description of what you changed and why
  • Any relevant context or links

📋 Contribution Ideas

For Beginners

  • Fix typos or broken links
  • Add clarifying comments to prompts
  • Share your success story
  • Suggest improvements to existing content

For Intermediate Contributors

  • Create domain adaptations for your field
  • Document new workflow patterns you've discovered
  • Add examples to existing prompts
  • Create quick reference cards

For Advanced Contributors

  • Build companion tools (browser extensions, IDE plugins)
  • Create video tutorials or walkthroughs
  • Develop automation scripts
  • Design comprehensive domain frameworks

🎨 Style Guidelines

Writing Style

  • Tone: Encouraging, practical, non-condescending
  • Voice: Active voice, second person ("you")
  • Format: Clear headings, bullet points, code blocks
  • Length: Be concise but thorough
  • Jargon: Explain technical terms when first used

Formatting

  • Use markdown for all documentation
  • Use code blocks with language tags: ```markdown, ```bash, etc.
  • Include examples for abstract concepts
  • Add visual separators (---) between major sections

File Naming

  • Use kebab-case: my-new-file.md
  • Be descriptive: data-science-adaptation.md not ds.md
  • Group related files in appropriate directories

🎯 Domain Adaptation Template

If you're creating a domain adaptation, use this structure:

# [Domain Name] Adaptation

## Overview
Brief description of how AI orchestration applies to this domain

## Prompt 1 Modifications (Learning Roadmap)
- What to change in the learning roadmap prompt
- Domain-specific skills to add
- Example filled-out prompt

## Prompt 2 Modifications (Tech Stack Analysis)
- What to analyze in this domain
- Key technologies to focus on
- Example stack breakdown

## Prompt 3 Modifications (Senior-Junior Pattern)
- How escalation works in this domain
- Domain-specific report fields
- Example workflow

## AI Tool Specialization
Which AI tools work best for what in this domain

## Domain-Specific Resources
Links, courses, communities relevant to this field

## Example Journey
A "Sam's Journey" style narrative for this domain

🔄 Tool Update Protocol

When updating the AI Tool Matrix:

  1. Test the tool - Use it for real work, not just demos
  2. Compare to existing tools - Where does it excel? Where does it fall short?
  3. Update the CSV - Add new row or update existing
  4. Update the guide - Reference the tool in relevant sections
  5. Document your findings - Add a note about why this update was made

⚠️ What NOT to Contribute

Please avoid:

  • ❌ Promotional content for specific paid tools/services
  • ❌ Overly technical content without explanation
  • ❌ Content that contradicts core principles (AI orchestration, systems thinking)
  • ❌ Large binary files (images >1MB, videos)
  • ❌ Generated content without human review/editing
  • ❌ Personal information or credentials

🎓 Recognition

Contributors will be:

  • Listed in the Contributors section (if significant contribution)
  • Credited in the specific files they created/improved
  • Mentioned in release notes
  • Given our eternal gratitude! 🙏

📞 Questions?

  • Have a question before contributing? Open a Discussion
  • Found a bug or issue? Open an Issue
  • Want to propose a major change? Open an Issue first to discuss

📜 Code of Conduct

Be kind, be respectful, be constructive:

  • ✅ Assume good intentions
  • ✅ Provide constructive feedback
  • ✅ Be welcoming to newcomers
  • ✅ Respect different perspectives and experiences
  • ❌ No harassment, discrimination, or toxicity

🎉 Thank You!

Every contribution, no matter how small, helps make AI-augmented learning more accessible to everyone. Thank you for being part of this community!

Ready to contribute?

  1. ⭐ Star this repository
  2. 🍴 Fork it
  3. 🎨 Create your feature
  4. 📬 Submit a Pull Request

Let's build the future of learning together!

Tags: #aiorchestration #aiaugmentation #systemsthinking #fullstack #opensource #community