Skip to content

Add comprehensive contributor microagent guide#144

Draft
VianneyMI wants to merge 1 commit into
mainfrom
add-contributor-microagent
Draft

Add comprehensive contributor microagent guide#144
VianneyMI wants to merge 1 commit into
mainfrom
add-contributor-microagent

Conversation

@VianneyMI
Copy link
Copy Markdown
Owner

📋 Overview

This PR adds a comprehensive microagent guide to help developers and AI Code Agents get started contributing to the Monggregate project.

🚀 What's Added

  • New directory structure: .openhands/microagents/ for OpenHands microagents
  • Comprehensive guide: monggregate-contributor-guide.md with detailed documentation covering:
    • Repository structure and architecture
    • Development environment setup
    • Testing guidelines and code quality standards
    • Contribution workflow and best practices
    • Implicit rules and conventions
    • Software engineering best practices for the entire development lifecycle

🎯 Purpose

This microagent serves as a comprehensive onboarding resource that:

  • Helps new contributors understand the project structure and development practices
  • Assists AI Code Agents in making informed contributions
  • Documents implicit rules that aren't explicitly stated elsewhere
  • Provides software engineering best practices for the development lifecycle
  • Ensures consistency across all contributions

📚 Key Features

The microagent includes detailed sections on:

  • Project Overview: Understanding Monggregate's purpose and architecture
  • Development Setup: Step-by-step environment configuration
  • Code Quality: Linting, formatting, and type checking standards
  • Testing Strategy: Unit, integration, and end-to-end testing approaches
  • Documentation Standards: MkDocs integration and docstring conventions
  • Release Process: Version management and deployment procedures
  • Security Guidelines: Best practices for handling sensitive data
  • Performance Optimization: Strategies for efficient MongoDB operations

🔧 Technical Details

  • Format: Markdown with YAML frontmatter for microagent metadata
  • Location: .openhands/microagents/monggregate-contributor-guide.md
  • Type: Knowledge microagent (no triggers required)
  • Compatibility: Works with CodeActAgent

✅ Checklist

  • Created .openhands/microagents/ directory structure
  • Added comprehensive contributor guide
  • Documented repository structure and architecture
  • Included development setup instructions
  • Covered testing and code quality standards
  • Documented implicit rules and conventions
  • Added software engineering best practices
  • Followed microagent format specifications

🎉 Benefits

This addition will:

  • Reduce onboarding time for new contributors
  • Improve code quality through documented standards
  • Enable better AI assistance with comprehensive context
  • Ensure consistent practices across the project
  • Preserve institutional knowledge in a structured format

The microagent is designed to be a living document that evolves with the project while maintaining comprehensive coverage of all aspects needed for successful contribution.

@VianneyMI can click here to continue refining the PR

- Create .openhands/microagents directory structure
- Add monggregate-contributor-guide.md with detailed documentation
- Include repository structure, development setup, and best practices
- Document implicit rules and software engineering guidelines
- Provide comprehensive guide for developers and AI Code Agents

Co-authored-by: openhands <openhands@all-hands.dev>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants