apache / apache/airflow

The Contributor's Quick Start isn't quick enough and needs some TLC

Open
#39,653 5 comments 2 reactions 1 assignee Claimed by @RNHTTR View on GitHub
kind:documentation
Dominant language
Python
Stars
46.9k
Forks
17.8k
Avg merge
2d 10h
Merged PRs (30d)
483

Description

### What do you see as an issue?

The [Contributor's Quick Start](https://github.com/apache/airflow/blob/main/contributing-docs/03_contributors_quick_start.rst) is super long and arguably confusing

There are also a handful of issues with the guide now. Here's an example, :

![image](https://github.com/apache/airflow/assets/25823361/05b0353a-f446-48f9-8050-ab79dab7f51e)

### Solving the problem

The guide references several different ways to run an Airflow dev environment:
* Containers with different flavors
* Docker
* Colima
* Docker compose
* Hatch, pyenv, pyenv-virtualenv, or virtualenvwrapper
* Postgres (not necessary for a lot of contributions, especially for someone new to contributing here)
* Breeze

I think we should align on the truly simplest way for users to make their first contribution and move everything else to separate guides.

### Anything else

_No response_

### Are you willing to submit PR?

- [X] Yes I am willing to submit a PR!

### Code of Conduct

- [X] I agree to follow this project's [Code of Conduct](https://github.com/apache/airflow/blob/main/CODE_OF_CONDUCT.md)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.