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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
