Back to Airflow

{AIP Title} — Playbook

.agents/skills/aip-user-stories/references/playbook-template.md

3.3.0b12.1 KB
Original Source
<!-- SPDX-License-Identifier: Apache-2.0 https://www.apache.org/licenses/LICENSE-2.0 -->

{AIP Title} — Playbook

Airflow version: {version} Required packages: {packages, if any beyond core}

Prerequisites

{Version requirements, installation steps for provider packages if needed, configuration prerequisites.}

Overview

{2-3 paragraphs drawn from the AIP motivation section. What problem does this feature solve? What was the previous state? What changes for the user? Written for a practitioner, not a committee.}


Recipes (Post-Implementation Mode)

{Repeat this section for each recipe.}

{Recipe Title}

Goal: {One sentence — what the user accomplishes with this recipe.}

Prerequisites: {Anything specific to this recipe beyond the global prerequisites — a provider package, a configuration flag, an external service.}

python
{Code block — verified, adapted, or placeholder per the three-tier system.}

{If adapted, note below the block: "Adapted from [source file path]"}

{Explanation: WHY this pattern works, not line-by-line narration. What makes this the right approach for this use case.}


User Stories (Pre-Implementation Mode)

{Repeat this section for each user story.}

{Story Title}

Goal: {One sentence — the user's objective.}

python
# PROPOSED API — not yet implemented
{Speculative code based on the AIP's proposed API.}

{Brief explanation of what this code would accomplish and why the AIP proposes this approach.}

Open Design Questions:

  • {Specific question about API ergonomics for this use case}
  • {Specific question about edge cases relevant to this story}
  • {Specific question about compatibility with existing Airflow patterns}
  • {Specific question about implementation feasibility or constraints}

Not Yet Implemented

{Include only if the user chose to skip unimplemented features during the Propose phase. List each skipped feature with a one-line description. Omit this entire section if all features were covered.}

  • {Feature name} — {one-line description from AIP}