You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "potiuk (via GitHub)" <gi...@apache.org> on 2026/05/02 16:16:12 UTC
[PR] docs: extend Adopting the framework section for PR-skill adopter contract [airflow-steward]
potiuk opened a new pull request, #34:
URL: https://github.com/apache/airflow-steward/pull/34
## Summary
- Restructure the top-level README's `## Adopting the framework` section into four subsections: `Bootstrapping a new adopter` (concrete commands), `Per-skill-family contract` (security vs PR triage families), `How skills resolve <project-config>/ paths`, and `Keeping the submodule current` (preserves the existing post-merge-hook guidance).
- `projects/_template/README.md`: add a `### PR triage and review` subsection listing the four scaffold files added in #33 (`pr-triage-config.md`, `pr-triage-comment-templates.md`, `pr-triage-ci-check-map.md`, `pr-maintainer-review-criteria.md`) with per-file purpose. Split the "Checklist after copying" into three groups (security / PR / common finishers) so adopters using only one family can skip the other.
- doctoc TOCs regenerated for both files.
## Context
The four PR-skill scaffold files landed in #33 but the adoption flow was only briefly mentioned. This PR documents the contract end-to-end so a non-airflow project can:
1. Read the bootstrap walk-through with concrete `git submodule add` / `cp -r` / `ln -s` commands.
2. Follow the per-skill-family table to know which `<project-config>/` files apply to their use case.
3. Find the "what does each file do" detail in the adopter-side `projects/_template/README.md`.
4. Run a checklist that flags the minimum content each family needs.
Both surfaces carry the same disclaimer that the framework currently embeds airflow-flavoured defaults inline in the PR-skill supporting files; a **follow-up PR completes the extraction**. Until then, non-airflow adopters override by forking the relevant supporting file into their own `.claude/skills/<skill-name>/`.
## Test plan
- [x] All pre-commit hooks pass (markdownlint, typos, doctoc, check-placeholders)
- [x] doctoc regenerates both TOCs cleanly
- [x] No new anchors broken — existing `#adopting-the-framework` and `#pr-triage-and-review` anchors preserved
- [ ] Reviewer eyeballs the per-skill-family table for accuracy of "which file for which skill"
- [ ] CI link-check (lychee) passes
🤖 Generated with [Claude Code](https://claude.com/claude-code)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: extend Adopting the framework section for PR-skill adopter contract [airflow-steward]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk merged PR #34:
URL: https://github.com/apache/airflow-steward/pull/34
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org