This is an automated email from the ASF dual-hosted git repository.
kaxilnaik pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 0675febb029 Improve formatting for Codespaces setup instructions
(#56496)
0675febb029 is described below
commit 0675febb029b368addf53bb5a8371be7afb24ec5
Author: Anusha Kovi <[email protected]>
AuthorDate: Mon Oct 13 05:59:35 2025 -0700
Improve formatting for Codespaces setup instructions (#56496)
Co-authored-by: Anusha Kovi <[email protected]>
---
.../03a_contributors_quick_start_beginners.rst | 53 ++++++++++------------
1 file changed, 25 insertions(+), 28 deletions(-)
diff --git a/contributing-docs/03a_contributors_quick_start_beginners.rst
b/contributing-docs/03a_contributors_quick_start_beginners.rst
index 11a2080238d..13a93356ff8 100644
--- a/contributing-docs/03a_contributors_quick_start_beginners.rst
+++ b/contributing-docs/03a_contributors_quick_start_beginners.rst
@@ -123,7 +123,8 @@ This flag enables configuration to load example DAGs when
starting Airflow, whic
git fetch upstream && git rebase upstream/main && git push
--force-with-lease
-## Option B – One-Click GitHub Codespaces
+Option B – One-Click GitHub Codespaces
+---------------------------------------
1. On **your fork**, click *Code → Codespaces → New codespace*.
2. Wait for the VS Code web IDE to appear. A terminal opens automatically.
@@ -131,39 +132,37 @@ This flag enables configuration to load example DAGs when
starting Airflow, whic
.. code-block:: bash
-```
-mkdir -p ~/.docker/cli-plugins
+ mkdir -p ~/.docker/cli-plugins
-# Install Docker Buildx
-BUILDX_VERSION=v0.16.2
-curl -SL
"https://github.com/docker/buildx/releases/download/${BUILDX_VERSION}/buildx-${BUILDX_VERSION}.linux-amd64";
-o ~/.docker/cli-plugins/docker-buildx
-chmod +x ~/.docker/cli-plugins/docker-buildx
-docker buildx version
+ # Install Docker Buildx
+ BUILDX_VERSION=v0.16.2
+ curl -SL
"https://github.com/docker/buildx/releases/download/${BUILDX_VERSION}/buildx-${BUILDX_VERSION}.linux-amd64";
-o ~/.docker/cli-plugins/docker-buildx
+ chmod +x ~/.docker/cli-plugins/docker-buildx
+ docker buildx version
-# Install Docker Compose v2
-curl -SL
"https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname
-s | tr '[:upper:]' '[:lower:]')-$(uname -m)" -o
~/.docker/cli-plugins/docker-compose
-chmod +x ~/.docker/cli-plugins/docker-compose
-docker compose version
-```
+ # Install Docker Compose v2
+ curl -SL
"https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname
-s | tr '[:upper:]' '[:lower:]')-$(uname -m)" -o
~/.docker/cli-plugins/docker-compose
+ chmod +x ~/.docker/cli-plugins/docker-compose
+ docker compose version
4. Install Breeze and start the development container
.. code-block:: bash
-```
-curl -LsSf https://astral.sh/uv/install.sh | sh
-uv tool install prek
-prek install -f
-uv tool install -e ./dev/breeze
-uv run setup_vscode.py
-breeze start-airflow
-```
-
-5. Edit a file in the editor, save, and commit via the Source Control
-sidebar. Push when prompted.
+ curl -LsSf https://astral.sh/uv/install.sh | sh
+ uv tool install prek
+ prek install -f
+ uv tool install -e ./dev/breeze
+ uv run setup_vscode.py
+ breeze start-airflow
+
+5. Edit a file in the editor, save, and commit via the Source Control sidebar.
+ Push when prompted.
+
6. Press **Create pull request** when GitHub offers.
+
Review & Merge
--------------
Respond to reviewer comments, push updates (same commands as above). Once
@@ -171,7 +170,5 @@ CI is green and reviews are ✅, a committer will merge. 🎉
Next Steps
----------
-* Need a full development environment? See
- :doc:`03b_contributors_quick_start_seasoned_developers`.
-* Learn about our contribution workflow:
- :doc:`04_how_to_contribute`.
+* Need a full development environment? See the `Development Environments Guide
<https://github.com/apache/airflow/blob/main/contributing-docs/06_development_environments.rst>`_.
+* Learn about our contribution workflow? Checkout the `Contribution Workflow
Guide
<https://github.com/apache/airflow/blob/main/contributing-docs/18_contribution_workflow.rst>`_.
