Skip to content

Update beginner quickstart guide#67952

Open
Ei-Sandi wants to merge 1 commit into
apache:mainfrom
Ei-Sandi:beginner-quickstart-update
Open

Update beginner quickstart guide#67952
Ei-Sandi wants to merge 1 commit into
apache:mainfrom
Ei-Sandi:beginner-quickstart-update

Conversation

@Ei-Sandi
Copy link
Copy Markdown

@Ei-Sandi Ei-Sandi commented Jun 3, 2026

Description

This PR updates contributing-docs/03a_contributors_quick_start_beginners.rst to fix outdated instruction and add missing prerequisites for running local tests.

  1. Update Default Terminal Multiplexer: Clarified that Breeze now uses mprocs as the default multiplexer instead of tmux, and added instructions on how to use tmux via the --terminal-multiplexer tmux option if preferred.
  2. Fix Breeze Exit Instructions: Updated the guide from the outdated stop_airflow command to reflect that users need to press q to quit, and added instructions to run breeze down afterward to properly spin down containers.
  3. Add Missing Pre-commit Prerequisites: Added a relative link to the virtual environment setup guide right before the prek --all-files step. Previously, the guide lacked instructions to configure the .venv and install dependencies first, which caused pre-commit validation tests to fail for new users.

Was generative AI tooling used to co-author this PR?
  • Yes (please specify the tool below)
    (Gemini 3.5 flash - to draft this PR description.)

  • Read the Pull Request Guidelines for more information. Note: commit author/co-author name and email in commits become permanently public when merged.
  • For fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
  • When adding dependency, check compliance with the ASF 3rd Party License Policy.
  • For significant user-facing changes create newsfragment: {pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.

@boring-cyborg
Copy link
Copy Markdown

boring-cyborg Bot commented Jun 3, 2026

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our prek-hooks will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example Dag that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@Ei-Sandi Ei-Sandi marked this pull request as ready for review June 3, 2026 11:29
Comment thread contributing-docs/03a_contributors_quick_start_beginners.rst Outdated
@Ei-Sandi Ei-Sandi force-pushed the beginner-quickstart-update branch from 73bcf10 to 925f5f5 Compare June 3, 2026 12:00
Comment thread contributing-docs/03a_contributors_quick_start_beginners.rst
Copy link
Copy Markdown
Contributor

@Prab-27 Prab-27 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool ! Overall LGTM !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants