docs/contributing.md

"""Documentation: Contributing Guide"""

Contributing to Burme-Coder-Max

We welcome contributions! This guide covers how to contribute.

---

Ways to Contribute

• 🐛 Report bugs
• 💡 Suggest features
• 📝 Improve documentation
• 🔧 Submit code changes
• ✅ Test new features

---

Development Setup

1. Fork and Clone

git clone https://github.com/YOUR_USERNAME/burme-coder-max.git
cd burme-coder-max

2. Create Virtual Environment

python -m venv venv
source venv/bin/activate  # Linux/Mac
# or
venv\Scripts\activate  # Windows

3. Install Dependencies

pip install -e ".[dev]"

4. Install Pre-commit Hooks

pre-commit install

---

Making Changes

1. Create a Branch

git checkout -b feature/my-feature
# or
git checkout -b fix/my-bug

2. Make Your Changes

• Follow existing code style
• Add tests for new features
• Update documentation

3. Run Tests

pytest tests/ -v

4. Run Linters

black src/ tests/
mypy src/

---

Code Style

• Follow PEP 8
• Use type hints
• Add docstrings
• Keep functions small and focused

Example

from typing import List, Optional


def search_knowledge(query: str, category: Optional[str] = None) -> List[dict]:
    """
    Search the knowledge base for relevant content.

    Args:
        query: Search query string
        category: Optional category filter

    Returns:
        List of matching entries
    """
    # implementation
    pass

---

Commit Messages

Format:

type: Short description

Longer explanation if needed.

Types:

• feat: New feature
• fix: Bug fix
• docs: Documentation
• style: Formatting
• refactor: Code restructuring
• test: Tests
• chore: maintenance

Example:

feat: Add particle burst animation

Add celebration effect with customizable particle count.
Fixes #12

---

Pull Request Process

1. Update documentation for new features
2. Add tests
3. Ensure all tests pass
4. Update CHANGELOG.md
5. Submit PR with clear description

---

Reporting Issues

When reporting bugs:

• Describe the issue clearly
• Steps to reproduce
• Expected vs actual behavior
• Python version and OS
• Error messages

---

Questions?

• 📧 Email: contact@amkyawdev.com
• 💬 GitHub Discussions
• 🤝 Community Discord

---

Thank you for contributing! 🙏