Skip to content

docs: add host vs container context note to Breeze quick start for new contributors#63435

Merged
potiuk merged 1 commit intoapache:mainfrom
Pranaykarvi:docs/improve-breeze-contributions
Mar 12, 2026
Merged

docs: add host vs container context note to Breeze quick start for new contributors#63435
potiuk merged 1 commit intoapache:mainfrom
Pranaykarvi:docs/improve-breeze-contributions

Conversation

@Pranaykarvi
Copy link
Contributor

Currently the "Configuring prek" section in the contributor quick start
does not specify where to run the commands. New contributors who have
just entered a Breeze shell may try running prek inside the container
and get confusing errors.

This change adds a short note at the start of the section clarifying
that prek commands should be run on the host machine, not inside Breeze.

This directly addresses the host vs. container context confusion that
affects both human contributors and AI coding agents working on Airflow.

Related: #62500

@boring-cyborg boring-cyborg bot added area:dev-tools backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch labels Mar 12, 2026
@potiuk
Copy link
Member

potiuk commented Mar 12, 2026

Nice. Useful clarification !

@potiuk potiuk merged commit 76ef7c4 into apache:main Mar 12, 2026
62 checks passed
@boring-cyborg
Copy link

boring-cyborg bot commented Mar 12, 2026

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

github-actions bot pushed a commit that referenced this pull request Mar 12, 2026
…start for new contributors (#63435)

(cherry picked from commit 76ef7c4)

Co-authored-by: Pranay Kumar Karvi <pranaykarvi@gmail.com>
Made-with: Cursor
@github-actions
Copy link

Backport successfully created: v3-1-test

Note: As of Merging PRs targeted for Airflow 3.X
the committer who merges the PR is responsible for backporting the PRs that are bug fixes (generally speaking) to the maintenance branches.

In matter of doubt please ask in #release-management Slack channel.

Status Branch Result
v3-1-test PR Link

github-actions bot pushed a commit to aws-mwaa/upstream-to-airflow that referenced this pull request Mar 12, 2026
…start for new contributors (apache#63435)

(cherry picked from commit 76ef7c4)

Co-authored-by: Pranay Kumar Karvi <pranaykarvi@gmail.com>
Made-with: Cursor
github-actions bot pushed a commit to giovannigamez05/airflow that referenced this pull request Mar 12, 2026
…start for new contributors (apache#63435)

(cherry picked from commit 76ef7c4)

Co-authored-by: Pranay Kumar Karvi <pranaykarvi@gmail.com>
Made-with: Cursor
Pyasma pushed a commit to Pyasma/airflow that referenced this pull request Mar 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:dev-tools backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants