apache / apache/airflow

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

Đang mở
#39,653 5 bình luận 2 reaction 1 người được giao Được @RNHTTR nhận Xem trên GitHub
kind:documentation
Ngôn ngữ chính
Python
Star
46.9k
Fork
17.8k
Merge trung bình
2 ngày 10 giờ
Pull request đã merge (30 ngày)
483

Mô tả

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.