Contributing Guidelines

# Check for issues
ruff check .

# Auto-fix issues
ruff check --fix .

# Format code
ruff format .

from typing import Optional

def send_notification(template_id: str, recipient: str) -> dict[str, str]:
    # Function implementation
    pass

mypy

# Install hooks (one time)
pre-commit install --install-hooks

# Manually run on all files
pre-commit run --all-files

git checkout -b feature/your-feature-name

app/
├── v2/                      # Public API endpoints
│   ├── notifications/       # Feature grouping
│   │   ├── __init__.py     # Blueprint registration
│   │   └── post_notifications.py  # Individual endpoint
│   └── errors.py            # Public API error handling
├── <feature>/               # Internal features
│   ├── rest.py             # Internal REST endpoints
│   └── ...
├── dao/                     # Data access objects
├── models.py                # SQLAlchemy models
└── schemas.py               # Marshmallow schemas

# Run tests while developing
make watch-tests

# Run full test suite
make test

make test

git add .
git commit -m "Add SMS delivery status webhook endpoint

- Create new v2 endpoint for delivery status callbacks
- Add validation for provider-specific payload formats
- Include tests for MMG and Firetext providers

Closes #123"

git push origin feature/your-feature-name

app/v2/inbound_sms/
├── __init__.py              # Blueprint registration
└── get_inbound_sms.py       # Endpoint implementation

from flask import Blueprint
from app.v2.errors import register_errors

v2_notification_blueprint = Blueprint(
    "v2_notifications",
    __name__,
    url_prefix='/v2/notifications'
)

register_errors(v2_notification_blueprint)

# Public API errors (app/v2/errors.py)
register_errors(v2_notification_blueprint)

# Internal API errors (app/errors.py)
# Different format and detail level

v2_notification_blueprint.before_request(requires_auth)
application.register_blueprint(v2_notification_blueprint)

# Create a new migration
flask db migrate -m "Add index to notifications table"

# Review the generated migration in migrations/versions/

# Apply migrations
flask db upgrade

# Included in test dependencies
squawk-cli migrations/versions/xxx_migration.py

# For production dependencies
echo "new-package==1.2.3" >> requirements.in

# For test dependencies
echo "new-test-package==1.2.3" >> requirements_for_test.in

# Compile and sync
make freeze-requirements

make bump-utils

import pytest
from app.models import Notification

def test_create_notification(sample_template):
    notification = Notification(
        template=sample_template,
        to="[email protected]"
    )
    assert notification.status == "created"

def test_send_email_via_api(client, sample_api_key):
    response = client.post(
        "/v2/notifications/email",
        json={"email_address": "[email protected]"},
        headers={"Authorization": f"Bearer {sample_api_key}"}
    )
    assert response.status_code == 201

from moto import mock_s3
from freezegun import freeze_time

@mock_s3
@freeze_time("2024-01-15")
def test_archive_old_notifications():
    # Your test code
    pass

make check-if-migrations-to-run