Skip to content

Contributors quickstart: fix RST style #56572

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ecodina wants to merge 2 commits into from
Closed

Contributors quickstart: fix RST style #56572

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b4ab40
Fix title in RST format
ecodina Oct 12, 2025
7762104
fix code block formatting
ecodina Oct 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 25 additions & 24 deletions contributing-docs/03a_contributors_quick_start_beginners.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,44 +123,45 @@ 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.

3. Install Docker Buildx and Docker Compose (required for Breeze)

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


Expand Down