Skip to content

Add libxml2 install command for macOS in contributor quick start doc#36388

Merged
hussein-awala merged 2 commits intoapache:mainfrom
yysd5:improve-contributors-doc
Dec 23, 2023
Merged

Add libxml2 install command for macOS in contributor quick start doc#36388
hussein-awala merged 2 commits intoapache:mainfrom
yysd5:improve-contributors-doc

Conversation

@yysd5
Copy link
Copy Markdown
Contributor

@yysd5 yysd5 commented Dec 23, 2023

The both documents below states that libxml2 should be installed as a required package for the pre-commit hook.
While the first document includes installation commands for both Linux and Mac, the next document lacks instructions for Mac. So, I have added the Mac installation commands here.

https://github.com/apache/airflow/blob/main/STATIC_CODE_CHECKS.rst#pre-commit-hooks
https://github.com/apache/airflow/blob/main/CONTRIBUTORS_QUICK_START.rst#configuring-pre-commit


^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
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 newsfragments.

@boring-cyborg
Copy link
Copy Markdown

boring-cyborg bot commented Dec 23, 2023

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 Contribution Guide (https://github.com/apache/airflow/blob/main/CONTRIBUTING.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: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@yysd5 yysd5 force-pushed the improve-contributors-doc branch from 701c000 to 2216a27 Compare December 23, 2023 09:00
Comment thread CONTRIBUTORS_QUICK_START.rst Outdated
Co-authored-by: Andrey Anshin <Andrey.Anshin@taragol.is>
@hussein-awala hussein-awala merged commit e6b4f7d into apache:main Dec 23, 2023
@boring-cyborg
Copy link
Copy Markdown

boring-cyborg bot commented Dec 23, 2023

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

@hussein-awala
Copy link
Copy Markdown
Member

Congrats on your first commit 🎉

@yysd5
Copy link
Copy Markdown
Contributor Author

yysd5 commented Dec 24, 2023

Congrats on your first commit 🎉

@hussein-awala
Thank you!!
Even though it was just a small fix to the doc, I'm happy to have made my first contribution to Airflow, which I always use🙏
If there are other issues that seem within my capacity, I'll try to tackle them.

@yysd5 yysd5 deleted the improve-contributors-doc branch December 24, 2023 04:00
@ephraimbuddy ephraimbuddy added this to the Airflow 2.8.2 milestone Feb 19, 2024
@ephraimbuddy ephraimbuddy added the changelog:skip Changes that should be skipped from the changelog (CI, tests, etc..) label Feb 19, 2024
ephraimbuddy pushed a commit that referenced this pull request Feb 20, 2024
…36388)

* add libxml2 install command for macOS in contributor quick start doc

* Update CONTRIBUTORS_QUICK_START.rst

Co-authored-by: Andrey Anshin <Andrey.Anshin@taragol.is>

---------

Co-authored-by: Andrey Anshin <Andrey.Anshin@taragol.is>
(cherry picked from commit e6b4f7d)
ephraimbuddy pushed a commit that referenced this pull request Feb 22, 2024
…36388)

* add libxml2 install command for macOS in contributor quick start doc

* Update CONTRIBUTORS_QUICK_START.rst

Co-authored-by: Andrey Anshin <Andrey.Anshin@taragol.is>

---------

Co-authored-by: Andrey Anshin <Andrey.Anshin@taragol.is>
(cherry picked from commit e6b4f7d)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog:skip Changes that should be skipped from the changelog (CI, tests, etc..)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants