amoghrajesh opened a new pull request, #55930:
URL: https://github.com/apache/airflow/pull/55930
<!--
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.
-->
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
The original `03_contributors_quick_start.rst` is 850+ lines and
overwhelmingfor newcomers, covering Docker installation, multiple environment
options, and advanced tooling before reaching the core goal of opening a first
PR.
My aim through this PR is to splits the guide into two focused paths:
- `03a_contributors_quick_start_beginners.rst`: 5-minute path with Breeze or
Codespaces only, perfect for first-time contributors and for ultra fast
onboarding to the project
- `03b_contributors_quick_start_seasoned_developers.rst`: comprehensive
guide for experienced developers who need full dev environment
The split looks like such:
### `03a_contributors_quick_start_beginners.rst` (NEW)
- **5-minute path** to first PR
- **Two options only**: Breeze (local) or GitHub Codespaces (hosted)
- **Minimal prerequisites**: Docker + UV + system specs upfront
- **Clear success path**: Fork → Clone → Install → Change → Commit → PR
### `03b_contributors_quick_start_seasoned_developers.rst`
- **Comprehensive guide** for experienced developers
- **Full technical details**: Docker install, multiple backends, testing,
IDE setup
- **Advanced tooling**: Prek hooks, Breeze deep-dive, provider development
## Basic Testing for CodeSpaces
I was able to spin up a breeze inside codespaces:
<img width="2240" height="1280" alt="image"
src="https://github.com/user-attachments/assets/2846d9b0-1efe-41e0-af40-cf39d54b104c";
/>
Ran a dag test too:
<img width="2240" height="1280" alt="image"
src="https://github.com/user-attachments/assets/b9d92fed-e126-4916-94ff-5472211a0ab5";
/>
### TODO
- [ ] Figure out how to access the ports and stuff for Airflow UI when
launched in codespaces
<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)**
for more information.
In case of fundamental code changes, an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party
License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in a
newsfragment file, named `{pr_number}.significant.rst` or
`{issue_number}.significant.rst`, in
[airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
--
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]
