Skip to content

Inconsistent capitalization and verb tense in Alembic migration descriptions #69496

Description

@roykoand

Under which category would you file this issue?

Airflow Core

Apache Airflow version

3.2.2

What happened and how to reproduce it?

Well, this is more of a nitpick and not that important, but there are quite a few inconsistencies in Alembic migration descriptions that I noticed.

  1. Some migration descriptions start from a capital letter, some from lower case letter
Revision Description
53ff648b8a26 Add revoked_token table.
e79fc784f145 add timetable_type to dag table for filtering.
  1. Some migration descriptions use imperative mood (Add, Remove, Fix) while a few deviate (Added/Adding):
Revision Description
c4602ba06b4b Added DagPriorityParsingRequest table.
8e1c784a4fc7 Adding max_consecutive_failed_dag_runs column to dag_model table.

What you think should happen instead?

Proposed standard:

  • Start with a capital letter
  • Use imperative mood (Add, Remove, Fix, Rename, etc.)

This matches what the majority already follows and is consistent with Git commit message conventions.

A note in the contributor guide or a simple lint check could prevent this from drifting further.

Operating System

No response

Deployment

None

Apache Airflow Provider(s)

No response

Versions of Apache Airflow Providers

No response

Official Helm Chart version

Not Applicable

Kubernetes Version

No response

Helm Chart configuration

No response

Docker Image customizations

No response

Anything else?

No response

Are you willing to submit PR?

  • Yes I am willing to submit a PR!

Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:db-migrationsPRs with DB migrationkind:bugThis is a clearly a bugneeds-triagelabel for new issues that we didn't triage yet

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions