Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
107 lines (81 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

107 lines (81 loc) · 2.59 KB

Contributing to Game Studio Sub-Agents

A project by Tuna Pamir

Thank you for your interest in contributing! This project aims to make game development accessible to everyone through AI assistance.

How to Contribute

🐛 Reporting Bugs

  • Use the GitHub Issues tab
  • Include your project-config.json (remove sensitive data)
  • Describe expected vs actual behavior
  • Include error messages if any

💡 Suggesting Features

  • Check existing issues first
  • Describe the problem your feature solves
  • Provide use case examples
  • Consider implementation complexity

📝 Improving Documentation

  • Fix typos and clarify instructions
  • Add examples and use cases
  • Translate documentation
  • Create video tutorials

🤖 Creating New Agents

  1. Identify a gap in current capabilities
  2. Define agent responsibilities clearly
  3. Follow existing agent template structure
  4. Integrate with orchestrator and producer
  5. Add documentation and examples

🎮 Sharing Your Games

  • Add your game to the showcase
  • Share development experiences
  • Provide feedback on agent performance
  • Suggest workflow improvements

Development Setup

# Fork and clone
git clone https://github.com/pamirtuna/gamestudio-subagents.git
cd gamestudio-subagents

# Create branch
git checkout -b feature/your-feature-name

# Make changes
# Test with actual projects
# Commit with clear messages

# Push and create PR
git push origin feature/your-feature-name

Code Standards

Agent Templates

  • Clear role definition
  • Structured communication protocols
  • Comprehensive command documentation
  • Error handling guidelines

Python Scripts

  • Python 3.8+ compatibility
  • Type hints where applicable
  • Docstrings for functions
  • Handle exceptions gracefully

Documentation

  • Clear and concise
  • Include examples
  • Keep updated with changes
  • Use proper markdown formatting

Testing

Before submitting:

  1. Test project initialization
  2. Verify agent activation works
  3. Check documentation accuracy
  4. Run through example workflows

Pull Request Process

  1. Update documentation for any changes
  2. Add examples if introducing new features
  3. Ensure all agents still coordinate properly
  4. Request review from maintainers

Community Guidelines

  • Be respectful and constructive
  • Help newcomers get started
  • Share knowledge and experiences
  • Celebrate others' contributions

Recognition

Contributors will be added to:

  • README.md contributors section
  • Special thanks in release notes
  • Community showcase for significant contributions

Thank you for helping make game development more accessible!