Files
my-pal-mcp-server/.github/pull_request_template.md
2025-06-11 13:04:30 +02:00

3.5 KiB

Closes #

Type of Change

  • 🐞 Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • 🛠️ New Gemini tool (adds a new tool like chat, codereview, etc.)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📖 Documentation update
  • 🧹 Refactor or chore (no user-facing changes)
  • 🏗️ Infrastructure/CI changes

Description

Testing

Unit Tests (Required)

  • I have added new unit tests to cover my changes
  • I have run python -m pytest tests/ --ignore=tests/test_live_integration.py -v and all tests pass
  • New tests use proper mocking and don't require API keys
  • I have tested this with a real Gemini API key using python tests/test_live_integration.py
  • The changes work as expected with actual API calls
  • I have tested this on [macOS/Linux/Windows (WSL2)]

Docker Testing (If Applicable)

  • I have tested the Docker build: docker build -t test-image .
  • I have tested the Docker functionality: ./setup-docker.sh
  • Docker integration works with the changes

Code Quality

  • My code follows the project's style guidelines (black . and ruff check .)
  • I have run the linting tools and fixed any issues
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • I have updated type hints where applicable

Documentation

  • I have made corresponding changes to the documentation
  • I have updated the README.md if my changes affect usage
  • I have updated CONTRIBUTING.md if my changes affect the development workflow
  • For new tools: I have added usage examples and parameter documentation

Breaking Changes

  • This change is backwards compatible
  • OR: I have documented the breaking changes and migration path below

Additional Context

Checklist for Maintainers

  • Code review completed
  • All CI checks passing
  • Breaking changes properly documented
  • Version bump needed (if applicable)
  • Documentation updated and accurate