Back to list
tumma72

testing-guidelines

by tumma72

A CLI to perform local archiving of GMail emails in mbox format. It keeps GMail clean and tidy, while allowing local search for older emails

2🍴 0📅 Dec 23, 2025

SKILL.md


name: testing-guidelines description: >- Pytest testing patterns, fixtures, mocking, and coverage for GMailArchiver. Use when writing unit tests, integration tests, creating fixtures, mocking Gmail API, or checking coverage. Triggers on: test, pytest, fixture, mock, coverage, conftest, assert, unit test, integration test.

Testing Guidelines for GMailArchiver

This skill provides guidance on testing practices and patterns.

Source Documentation

Always read the authoritative source:

docs/TESTING.md - The definitive testing guidelines document containing:

  • Test organization and structure
  • Naming conventions for tests
  • Fixture patterns and usage
  • Mocking strategies (especially for Gmail API)
  • Coverage requirements and targets
  • Integration vs unit test guidelines
  • Test data management

Key Test Files

  • tests/conftest.py - Shared fixtures and configuration
  • tests/test_*.py - Test modules (match source structure)

Test Commands

# Run all tests with coverage
uv run pytest

# Run specific test file
uv run pytest tests/test_module.py -v

# Run specific test function
uv run pytest tests/test_module.py::test_name -v

# Run without coverage (faster)
uv run pytest --no-cov

# Run with coverage report
uv run pytest --cov=src/gmailarchiver --cov-report=html

Coverage Requirements

  • Overall: 95%+ coverage
  • Core modules: Higher coverage expected
  • See docs/TESTING.md for specific targets

Usage

When writing tests:

  1. Read docs/TESTING.md for current testing guidelines
  2. Check tests/conftest.py for available fixtures
  3. Follow existing test patterns in similar test files
  4. If guidelines change, update docs/TESTING.md (not this skill)

The source documentation is the single source of truth - this skill just points you there.

Score

Total Score

70/100

Based on repository quality metrics

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

+10
説明文

100文字以上の説明がある

+10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新がある

0/10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

0/5

Reviews

💬

Reviews coming soon