You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "amoghrajesh (via GitHub)" <gi...@apache.org> on 2025/09/21 16:54:36 UTC

[PR] Add beginner friendly quick start guide for first time contributors [airflow]

amoghrajesh opened a new pull request, #55930:
URL: https://github.com/apache/airflow/pull/55930

   <!--
    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at
   
      http://www.apache.org/licenses/LICENSE-2.0
   
    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.
    -->
   
   <!--
   Thank you for contributing! Please make sure that your code changes
   are covered with tests. And in case of new features or big changes
   remember to adjust the documentation.
   
   Feel free to ping committers for the review!
   
   In case of an existing issue, reference it using one of the following:
   
   closes: #ISSUE
   related: #ISSUE
   
   How to write a good git commit message:
   http://chris.beams.io/posts/git-commit/
   -->
   
   
   The original `03_contributors_quick_start.rst` is 850+ lines and overwhelmingfor newcomers, covering Docker installation, multiple environment options, and advanced tooling before reaching the core goal of opening a first PR.
   
   
   My aim through this PR is to splits the guide into two focused paths:
   - `03a_contributors_quick_start_beginners.rst`: 5-minute path with Breeze or Codespaces only, perfect for first-time contributors and for ultra fast onboarding to the project
   - `03b_contributors_quick_start_seasoned_developers.rst`: comprehensive guide for experienced developers who need full dev environment
   
   
   The split looks like such:
   
   
   ### `03a_contributors_quick_start_beginners.rst` (NEW)
   - **5-minute path** to first PR
   - **Two options only**: Breeze (local) or GitHub Codespaces (hosted)
   - **Minimal prerequisites**: Docker + UV + system specs upfront
   - **Clear success path**: Fork → Clone → Install → Change → Commit → PR
   
   ### `03b_contributors_quick_start_seasoned_developers.rst` 
   - **Comprehensive guide** for experienced developers
   - **Full technical details**: Docker install, multiple backends, testing, IDE setup
   - **Advanced tooling**: Prek hooks, Breeze deep-dive, provider development
   
   
   ## Basic Testing for CodeSpaces
   
   
   I was able to spin up a breeze inside codespaces:
   
   <img width="2240" height="1280" alt="image" src="https://github.com/user-attachments/assets/2846d9b0-1efe-41e0-af40-cf39d54b104c" />
   
   
   
   Ran a dag test too:
   
   <img width="2240" height="1280" alt="image" src="https://github.com/user-attachments/assets/b9d92fed-e126-4916-94ff-5472211a0ab5" />
   
   
   ### TODO
   
   - [ ] Figure out how to access the ports and stuff for Airflow UI when launched in codespaces
   
   <!-- Please keep an empty line above the dashes. -->
   ---
   **^ Add meaningful description above**
   Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)** for more information.
   In case of fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed.
   In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
   In case of backwards incompatible changes please leave a note in a newsfragment file, named `{pr_number}.significant.rst` or `{issue_number}.significant.rst`, in [airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
   


-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #55930:
URL: https://github.com/apache/airflow/pull/55930#discussion_r2374793886


##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__
+* Basic Git installed **only** for the Breeze path below
+
+For Breeze (local development):
+* Docker Community Edition
+* Docker Compose
+* UV for Python tool management
+
+.. code-block:: bash
+
+    curl -LsSf https://astral.sh/uv/install.sh | sh
+* Prek for code quality checks

Review Comment:
   Sure.



-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on PR #55930:
URL: https://github.com/apache/airflow/pull/55930#issuecomment-3318175153

   @Pyasma thank you! If you don't mind would you be able to follow the guide and let me know how it works for you if you have few mins to spare?


-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "gopidesupavan (via GitHub)" <gi...@apache.org>.
gopidesupavan commented on PR #55930:
URL: https://github.com/apache/airflow/pull/55930#issuecomment-3332251831

   @amoghrajesh amazing thanks for this, indeed it helps for very quick start guide . 


-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #55930:
URL: https://github.com/apache/airflow/pull/55930#discussion_r2374792441


##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__
+* Basic Git installed **only** for the Breeze path below
+
+For Breeze (local development):
+* Docker Community Edition
+* Docker Compose
+* UV for Python tool management
+
+.. code-block:: bash
+
+    curl -LsSf https://astral.sh/uv/install.sh | sh
+* Prek for code quality checks
+
+.. code-block:: bash
+
+    uv tool install prek
+    prek install -f
+* 4GB RAM, 40GB disk space, and at least 2 CPU cores
+
+.. note::
+   Docker installation varies by OS. See the `full guide <03b_contributors_quick_start_seasoned_developers.html#local-machine-development>`_ for Ubuntu, macOS, and Windows instructions.
+
+Option A – Breeze on Your Laptop
+--------------------------------
+1.  **Clone your fork and install Breeze**
+
+.. code-block:: bash
+
+    git clone https://github.com/<you>/airflow.git
+    cd airflow
+    uv tool install -e ./dev/breeze
+
+2.  **Start the development container** (first run builds the image)
+
+.. code-block:: bash
+
+    breeze start-airflow

Review Comment:
   Added in f9a7f56de9



-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "RNHTTR (via GitHub)" <gi...@apache.org>.
RNHTTR merged PR #55930:
URL: https://github.com/apache/airflow/pull/55930


-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "gopidesupavan (via GitHub)" <gi...@apache.org>.
gopidesupavan commented on PR #55930:
URL: https://github.com/apache/airflow/pull/55930#issuecomment-3332260068

   just one comment may be we can add `setup_idea.py` and `setup_vscode.py` references , it sets src/test modules correctly  in idea configs. WDYT?


-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on PR #55930:
URL: https://github.com/apache/airflow/pull/55930#issuecomment-3326999181

   > I checked the guide and it works well. I have one suggestion: could you also include this link in the guide?
   > 
   > https://airflow.apache.org/blog/apache-airflow-for-newcomers/
   
   @Pyasma this link is pretty outdated and I didn't want to include it for that reason.


-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #55930:
URL: https://github.com/apache/airflow/pull/55930#discussion_r2369100095


##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__
+* Basic Git installed **only** for the Breeze path below
+
+For Breeze (local development):
+* Docker Community Edition
+* Docker Compose
+* UV for Python tool management
+
+.. code-block:: bash
+
+    curl -LsSf https://astral.sh/uv/install.sh | sh
+* Prek for code quality checks
+
+.. code-block:: bash
+
+    uv tool install prek
+    prek install -f
+* 4GB RAM, 40GB disk space, and at least 2 CPU cores
+
+.. note::
+   Docker installation varies by OS. See the `full guide <03b_contributors_quick_start_seasoned_developers.html#local-machine-development>`_ for Ubuntu, macOS, and Windows instructions.
+
+Option A – Breeze on Your Laptop
+--------------------------------
+1.  **Clone your fork and install Breeze**
+
+.. code-block:: bash
+
+    git clone https://github.com/<you>/airflow.git
+    cd airflow
+    uv tool install -e ./dev/breeze

Review Comment:
   @phanikumv thanks, what was the error you were seeing?



-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #55930:
URL: https://github.com/apache/airflow/pull/55930#discussion_r2374777109


##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__
+* Basic Git installed **only** for the Breeze path below
+
+For Breeze (local development):
+* Docker Community Edition
+* Docker Compose
+* UV for Python tool management
+
+.. code-block:: bash
+
+    curl -LsSf https://astral.sh/uv/install.sh | sh
+* Prek for code quality checks
+
+.. code-block:: bash
+
+    uv tool install prek
+    prek install -f
+* 4GB RAM, 40GB disk space, and at least 2 CPU cores
+
+.. note::
+   Docker installation varies by OS. See the `full guide <03b_contributors_quick_start_seasoned_developers.html#local-machine-development>`_ for Ubuntu, macOS, and Windows instructions.
+
+Option A – Breeze on Your Laptop
+--------------------------------
+1.  **Clone your fork and install Breeze**
+
+.. code-block:: bash
+
+    git clone https://github.com/<you>/airflow.git
+    cd airflow
+    uv tool install -e ./dev/breeze
+
+2.  **Start the development container** (first run builds the image)
+
+.. code-block:: bash
+
+    breeze start-airflow

Review Comment:
   Both sound good, adding both



-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #55930:
URL: https://github.com/apache/airflow/pull/55930#discussion_r2374867698


##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__
+* Basic Git installed **only** for the Breeze path below
+
+For Breeze (local development):

Review Comment:
   We could I guess. But most are comfortable with docker?



-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #55930:
URL: https://github.com/apache/airflow/pull/55930#discussion_r2374798385


##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__
+* Basic Git installed **only** for the Breeze path below
+
+For Breeze (local development):
+* Docker Community Edition

Review Comment:
   Handled in f903de8390



-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "Pyasma (via GitHub)" <gi...@apache.org>.
Pyasma commented on PR #55930:
URL: https://github.com/apache/airflow/pull/55930#issuecomment-3318164110

   Hi @amoghrajesh,
   I’m relatively new to the project, and I really like the new guide you’ve made! The 5-minute path is super easy to follow and makes getting started much less overwhelming. As a first-time contributor, this is incredibly helpful—thank you!


-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "Pyasma (via GitHub)" <gi...@apache.org>.
Pyasma commented on PR #55930:
URL: https://github.com/apache/airflow/pull/55930#issuecomment-3318554513

   I checked the guide and it works well. I have one suggestion: could you also include this link in the guide?
   
   https://airflow.apache.org/blog/apache-airflow-for-newcomers/


-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "gopidesupavan (via GitHub)" <gi...@apache.org>.
gopidesupavan commented on PR #55930:
URL: https://github.com/apache/airflow/pull/55930#issuecomment-3337606454

   > > just one comment may be we can add `setup_idea.py` and `setup_vscode.py` references , it sets src/test modules correctly  in idea configs. WDYT?
   > 
   > Yea we should
   
   https://github.com/apache/airflow/pull/56137 created


-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #55930:
URL: https://github.com/apache/airflow/pull/55930#discussion_r2374870457


##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__
+* Basic Git installed **only** for the Breeze path below
+
+For Breeze (local development):

Review Comment:
   I mentioned in a note though in: 4ff8100488



-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "kaxil (via GitHub)" <gi...@apache.org>.
kaxil commented on PR #55930:
URL: https://github.com/apache/airflow/pull/55930#issuecomment-3333454884

   > just one comment may be we can add `setup_idea.py` and `setup_vscode.py` references , it sets src/test modules correctly  in idea configs. WDYT?
   
   Yea we should


-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "Pyasma (via GitHub)" <gi...@apache.org>.
Pyasma commented on PR #55930:
URL: https://github.com/apache/airflow/pull/55930#issuecomment-3318187869

   Hi @amoghrajesh,
   Thanks! I’ll give the guide a try and share my feedback soon.


-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #55930:
URL: https://github.com/apache/airflow/pull/55930#discussion_r2374801364


##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__

Review Comment:
   Handled in dbd85e2f97



-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "Prab-27 (via GitHub)" <gi...@apache.org>.
Prab-27 commented on code in PR #55930:
URL: https://github.com/apache/airflow/pull/55930#discussion_r2368741536


##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__
+* Basic Git installed **only** for the Breeze path below
+
+For Breeze (local development):
+* Docker Community Edition
+* Docker Compose
+* UV for Python tool management
+
+.. code-block:: bash
+
+    curl -LsSf https://astral.sh/uv/install.sh | sh
+* Prek for code quality checks
+
+.. code-block:: bash
+
+    uv tool install prek
+    prek install -f
+* 4GB RAM, 40GB disk space, and at least 2 CPU cores
+
+.. note::
+   Docker installation varies by OS. See the `full guide <03b_contributors_quick_start_seasoned_developers.html#local-machine-development>`_ for Ubuntu, macOS, and Windows instructions.
+
+Option A – Breeze on Your Laptop
+--------------------------------
+1.  **Clone your fork and install Breeze**
+
+.. code-block:: bash
+
+    git clone https://github.com/<you>/airflow.git
+    cd airflow
+    uv tool install -e ./dev/breeze
+
+2.  **Start the development container** (first run builds the image)
+
+.. code-block:: bash
+
+    breeze start-airflow

Review Comment:
   This is very helpful. 
   
   Just my thought—maybe we could add a quick note on how to exit tmux or use `stop_airflow`, since that might not be obvious to new contributors.



-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "phanikumv (via GitHub)" <gi...@apache.org>.
phanikumv commented on code in PR #55930:
URL: https://github.com/apache/airflow/pull/55930#discussion_r2368534452


##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__
+* Basic Git installed **only** for the Breeze path below
+
+For Breeze (local development):
+* Docker Community Edition
+* Docker Compose
+* UV for Python tool management
+
+.. code-block:: bash
+
+    curl -LsSf https://astral.sh/uv/install.sh | sh
+* Prek for code quality checks
+
+.. code-block:: bash
+
+    uv tool install prek
+    prek install -f
+* 4GB RAM, 40GB disk space, and at least 2 CPU cores
+
+.. note::
+   Docker installation varies by OS. See the `full guide <03b_contributors_quick_start_seasoned_developers.html#local-machine-development>`_ for Ubuntu, macOS, and Windows instructions.
+
+Option A – Breeze on Your Laptop
+--------------------------------
+1.  **Clone your fork and install Breeze**
+
+.. code-block:: bash
+
+    git clone https://github.com/<you>/airflow.git
+    cd airflow
+    uv tool install -e ./dev/breeze

Review Comment:
   ```suggestion
       uv tool install -e ./dev/breeze --force
   ```
   FWIW, it wasnt working on my machine unless I had the force option enabled.



-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "RNHTTR (via GitHub)" <gi...@apache.org>.
RNHTTR commented on code in PR #55930:
URL: https://github.com/apache/airflow/pull/55930#discussion_r2372679298


##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__

Review Comment:
   ```suggestion
   * [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo?tool=webui) `apache/airflow <https://github.com/apache/airflow>`__
   ```



##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__
+* Basic Git installed **only** for the Breeze path below
+
+For Breeze (local development):
+* Docker Community Edition
+* Docker Compose
+* UV for Python tool management
+
+.. code-block:: bash
+
+    curl -LsSf https://astral.sh/uv/install.sh | sh
+* Prek for code quality checks

Review Comment:
   ```suggestion
   * [Prek](https://github.com/j178/prek), which runs Airflow's required code-quality checks (formatting, linting, and bug-spotting) before you commit, helping save contributors and committers time during the pull request process.
   ```



##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__
+* Basic Git installed **only** for the Breeze path below
+
+For Breeze (local development):
+* Docker Community Edition

Review Comment:
   ```suggestion
   * [Docker Desktop](https://www.docker.com/products/docker-desktop/)
   ```



##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__
+* Basic Git installed **only** for the Breeze path below
+
+For Breeze (local development):
+* Docker Community Edition
+* Docker Compose

Review Comment:
   ```suggestion
   * [Docker Compose](https://docs.docker.com/compose/install/)
   ```



##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__
+* Basic Git installed **only** for the Breeze path below
+
+For Breeze (local development):
+* Docker Community Edition
+* Docker Compose
+* UV for Python tool management
+
+.. code-block:: bash
+
+    curl -LsSf https://astral.sh/uv/install.sh | sh
+* Prek for code quality checks
+
+.. code-block:: bash
+
+    uv tool install prek
+    prek install -f
+* 4GB RAM, 40GB disk space, and at least 2 CPU cores
+
+.. note::
+   Docker installation varies by OS. See the `full guide <03b_contributors_quick_start_seasoned_developers.html#local-machine-development>`_ for Ubuntu, macOS, and Windows instructions.
+
+Option A – Breeze on Your Laptop
+--------------------------------
+1.  **Clone your fork and install Breeze**
+
+.. code-block:: bash
+
+    git clone https://github.com/<you>/airflow.git
+    cd airflow
+    uv tool install -e ./dev/breeze
+
+2.  **Start the development container** (first run builds the image)
+
+.. code-block:: bash
+
+    breeze start-airflow
+
+3.  **Make a tiny change** – e.g. fix a typo in docs
+
+.. code-block:: bash
+
+    sed -i '' 's/Airflow/Airflow®/' contributing-docs/README.rst

Review Comment:
   Like, maybe it'd be better to say above...
   
   ```
   **Make a tiny change** – for example, fix a typo in the README
   ```
   
   and leave out any actual changes?



##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__
+* Basic Git installed **only** for the Breeze path below
+
+For Breeze (local development):
+* Docker Community Edition
+* Docker Compose
+* UV for Python tool management
+
+.. code-block:: bash
+
+    curl -LsSf https://astral.sh/uv/install.sh | sh
+* Prek for code quality checks
+
+.. code-block:: bash
+
+    uv tool install prek
+    prek install -f
+* 4GB RAM, 40GB disk space, and at least 2 CPU cores
+
+.. note::
+   Docker installation varies by OS. See the `full guide <03b_contributors_quick_start_seasoned_developers.html#local-machine-development>`_ for Ubuntu, macOS, and Windows instructions.
+
+Option A – Breeze on Your Laptop
+--------------------------------
+1.  **Clone your fork and install Breeze**
+
+.. code-block:: bash
+
+    git clone https://github.com/<you>/airflow.git
+    cd airflow
+    uv tool install -e ./dev/breeze
+
+2.  **Start the development container** (first run builds the image)
+
+.. code-block:: bash
+
+    breeze start-airflow
+
+3.  **Make a tiny change** – e.g. fix a typo in docs
+
+.. code-block:: bash
+
+    sed -i '' 's/Airflow/Airflow®/' contributing-docs/README.rst

Review Comment:
   Do we need this example? I don't want folks to get confused and think this is a necessary step



##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__
+* Basic Git installed **only** for the Breeze path below

Review Comment:
   I think we'll need the actual command to install git (or a link to instructions)



##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__
+* Basic Git installed **only** for the Breeze path below
+
+For Breeze (local development):

Review Comment:
   Maybe we can add podman as a drop-in replacement for docker that has no licensing restrictions as well?



##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__
+* Basic Git installed **only** for the Breeze path below
+
+For Breeze (local development):
+* Docker Community Edition
+* Docker Compose
+* UV for Python tool management
+
+.. code-block:: bash
+
+    curl -LsSf https://astral.sh/uv/install.sh | sh
+* Prek for code quality checks
+
+.. code-block:: bash
+
+    uv tool install prek
+    prek install -f
+* 4GB RAM, 40GB disk space, and at least 2 CPU cores
+
+.. note::
+   Docker installation varies by OS. See the `full guide <03b_contributors_quick_start_seasoned_developers.html#local-machine-development>`_ for Ubuntu, macOS, and Windows instructions.
+
+Option A – Breeze on Your Laptop
+--------------------------------
+1.  **Clone your fork and install Breeze**
+
+.. code-block:: bash
+
+    git clone https://github.com/<you>/airflow.git
+    cd airflow
+    uv tool install -e ./dev/breeze
+
+2.  **Start the development container** (first run builds the image)
+
+.. code-block:: bash
+
+    breeze start-airflow

Review Comment:
   maybe a link to tmux basics? When I started deeveloping on Airflow i was completely bamboozled by how to do anything in tmux 😅 



##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__
+* Basic Git installed **only** for the Breeze path below
+
+For Breeze (local development):
+* Docker Community Edition
+* Docker Compose
+* UV for Python tool management

Review Comment:
   ```suggestion
   * [uv](https://github.com/astral-sh/uv), which is a fast, reliable package manager that you'll use to install other developer tools to make contributing to Airflow easier.
   ```



-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #55930:
URL: https://github.com/apache/airflow/pull/55930#discussion_r2374797635


##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__
+* Basic Git installed **only** for the Breeze path below
+
+For Breeze (local development):
+* Docker Community Edition
+* Docker Compose
+* UV for Python tool management

Review Comment:
   Handled in f903de8390



##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__
+* Basic Git installed **only** for the Breeze path below
+
+For Breeze (local development):
+* Docker Community Edition
+* Docker Compose

Review Comment:
   Handled in f903de8390



-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #55930:
URL: https://github.com/apache/airflow/pull/55930#discussion_r2374776149


##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__
+* Basic Git installed **only** for the Breeze path below
+
+For Breeze (local development):
+* Docker Community Edition
+* Docker Compose
+* UV for Python tool management
+
+.. code-block:: bash
+
+    curl -LsSf https://astral.sh/uv/install.sh | sh
+* Prek for code quality checks
+
+.. code-block:: bash
+
+    uv tool install prek
+    prek install -f
+* 4GB RAM, 40GB disk space, and at least 2 CPU cores
+
+.. note::
+   Docker installation varies by OS. See the `full guide <03b_contributors_quick_start_seasoned_developers.html#local-machine-development>`_ for Ubuntu, macOS, and Windows instructions.
+
+Option A – Breeze on Your Laptop
+--------------------------------
+1.  **Clone your fork and install Breeze**
+
+.. code-block:: bash
+
+    git clone https://github.com/<you>/airflow.git
+    cd airflow
+    uv tool install -e ./dev/breeze

Review Comment:
   Alright, I figured it is because you already had breeze installed and you had to reinstall it. New contributor's wont run into that issue



-- 
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] Add beginner friendly quick start guide for first time contributors [airflow]

Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on code in PR #55930:
URL: https://github.com/apache/airflow/pull/55930#discussion_r2374865099


##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__
+* Basic Git installed **only** for the Breeze path below
+
+For Breeze (local development):
+* Docker Community Edition
+* Docker Compose
+* UV for Python tool management
+
+.. code-block:: bash
+
+    curl -LsSf https://astral.sh/uv/install.sh | sh
+* Prek for code quality checks
+
+.. code-block:: bash
+
+    uv tool install prek
+    prek install -f
+* 4GB RAM, 40GB disk space, and at least 2 CPU cores
+
+.. note::
+   Docker installation varies by OS. See the `full guide <03b_contributors_quick_start_seasoned_developers.html#local-machine-development>`_ for Ubuntu, macOS, and Windows instructions.
+
+Option A – Breeze on Your Laptop
+--------------------------------
+1.  **Clone your fork and install Breeze**
+
+.. code-block:: bash
+
+    git clone https://github.com/<you>/airflow.git
+    cd airflow
+    uv tool install -e ./dev/breeze
+
+2.  **Start the development container** (first run builds the image)
+
+.. code-block:: bash
+
+    breeze start-airflow
+
+3.  **Make a tiny change** – e.g. fix a typo in docs
+
+.. code-block:: bash
+
+    sed -i '' 's/Airflow/Airflow®/' contributing-docs/README.rst

Review Comment:
   Sounds good. Handled.



##########
contributing-docs/03a_contributors_quick_start_beginners.rst:
##########
@@ -0,0 +1,130 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+Your First Airflow Pull Request — 5-Minute Guide
+===============================================
+
+.. contents:: On this page
+   :local:
+   :depth: 1
+
+
+Purpose
+-------
+This page walks **new contributors** through opening their first
+Apache Airflow pull request (PR) in about five minutes.  We present *one*
+local option (Breeze) and *one* fully-hosted option (GitHub Codespaces).
+Everything else lives in the advanced guides.
+
+Prerequisites
+-------------
+* GitHub account
+* Fork `apache/airflow <https://github.com/apache/airflow>`__
+* Basic Git installed **only** for the Breeze path below

Review Comment:
   Handled it by adding a link



-- 
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