Skip to content
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

Merged
merged 12 commits into from
Dec 24, 2024

Conversation

IlaiGigi
Copy link
Contributor

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:

  1. Moving down the installation of the 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.
  2. Sqlite -> sqlite3: according to the Ubuntu package repository, the package sqlite is available only on focal and jammy Ubuntu distribution codenames. This means that the command sudo 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.
  3. Removing section describing pre-commit with uv (lines 466-479): this content was just duplicated with the few lines below it. There are more examples of this behavior, but they are less aggressive so I decided to leave them be.

The other changes I made are mostly cosmetic.

Copy link

boring-cyborg bot commented Dec 21, 2024

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)
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our pre-commits will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: [email protected]
    Slack: https://s.apache.org/airflow-slack

@IlaiGigi IlaiGigi marked this pull request as draft December 21, 2024 15:10
@potiuk
Copy link
Member

potiuk commented Dec 23, 2024

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 sqlite1 is just old name of the package installed, but I believe it was still sqlite3 even if it was named sqlite`

Copy link
Member

@potiuk potiuk left a 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"

@romsharon98 romsharon98 marked this pull request as ready for review December 23, 2024 14:34
@potiuk potiuk merged commit a540eeb into apache:main Dec 24, 2024
6 checks passed
Copy link

boring-cyborg bot commented Dec 24, 2024

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

@potiuk
Copy link
Member

potiuk commented Dec 24, 2024

Ho Ho Ho ! Nice present for contributors 🎅

@IlaiGigi
Copy link
Contributor Author

Thank you, I also plan to do the same for the other contributing docs when I find the time. 🎅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants