-
Notifications
You must be signed in to change notification settings - Fork 14.5k
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.
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
Update contributors quick start guide #45133
Update contributors quick start guide #45133
Conversation
Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
|
Very nice! Thanks @IlaiGigi ! BTW. Sqlite -> sqlite3 is not a problem (and we should change it to sqlite3 as you did). Sqlite3 was what we've always been using and |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Few nits to address. Looks good. Feel free to make it "ready to review"
Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions. |
Ho Ho Ho ! Nice present for contributors 🎅 |
Thank you, I also plan to do the same for the other contributing docs when I find the time. 🎅 |
This PR focuses on updating and formatting the contributors quick start guide.
As a new experimenting contributor, I had some troubles when I worked with the quick start guide, some commands that didn't work because of outdated packages, some instructions were unclear etc.
Addressing major changes I did:
docker compose plugin
: If we already have a section that is dedicated to the installation of docker compose, then commands that are relevant to its installation should be there, and not in a section that is dedicated to the installation of purely docker.sqlite
is available only onfocal
andjammy
Ubuntu distribution codenames. This means that the commandsudo apt install sqlite
will not work with any distributions beyond other than these two (like oracular, noble etc.). As I see it, these are the options:a. Move to
sqlite3
. This would require performing tests, which I have - ran all the tests under the ./tests directory, which is probably not sufficient.b. Add a note excluding distributions other than focal and jammy to use sqlite3 instead. This means developing on machines with distributions other than these may lead to inconsistencies as a result of breaking changes between the versions unless compatibility checks are done.
This is very likely larger than my PR, and the best course of action for now is probably to delay this change until a decision is made, I made the changes only to raise awareness.
The other changes I made are mostly cosmetic.