Update CONTRIBUTORS_QUICK_START.rst #19042

OyinOlamide · 2021-10-18T09:14:41Z

I am Oyinkansola Awosan, an Outreachy applicant for the December to March cohort. I noticed there was an error in the second block of code under the "Pyenv and setting up virtual-env" part of the guide. There was a letter 's' that was causing problems in the 'checking required packages' command.
I have corrected the error. This way other people who want to contribute to Apache won't face this issue I faced.
Thank you. :)

^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code change, 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 UPDATING.md.

I Oyinkansola Awosan, an Outreachy applicant for the December to March cohort. I noticed there was an error in the second block of code under the "Pyenv and setting up virtual-env" part of the guide. There was a letter 's' that was causing problems in the 'checking required packages' command. I have corrected the error. This way other people who want to contribute to Apache won't face this issue I faced. Thank you. :)

boring-cyborg · 2021-10-18T09:14:44Z

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 (flake8, 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.
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

I am Oyinkansola Awosan, an Outreachy applicant for the December to March round. This commit is to change the second block of code for 'Checking the required packages' under the 'Pyenv and setting up virtual-env' section. The present block of code returns various errors when run, but the new proposed block of code runs smoothly without errors and would help contributors set up easily when they want to contribute to Apache Airflow. Thank you.

CONTRIBUTORS_QUICK_START.rst

ephraimbuddy

Other places you should update too are:

airflow/breeze

Lines 276 to 277 in 1571f80

    
           echo "  sudo apt install build-essentials python3.6-dev python3.7-dev python3.8-dev python-dev openssl \\" 
        
           echo "              sqlite sqlite-dev default-libmysqlclient-dev libmysqld-dev postgresql"

airflow/INSTALL

Lines 10 to 11 in c747bce

    
           sudo apt install build-essentials python3.6-dev python3.7-dev python-dev openssl \ 
        
                            sqlite sqlite-dev default-libmysqlclient-dev libmysqld-dev postgresq

I am Oyinkansola Awosan, an Outreachy applicant for the December - March round. This commit takes out some unnecessary parts in the second block of code under the 'Pyenv and setting up virtual-env' section. This update will make setting up easier and smoother for contributors. Thank you!

potiuk · 2021-10-18T19:21:44Z

Other places you should update too are:

Yeah - would be nice to update those other places too - they give people some guldelines if their installation fails, so it's good if those guidelines are are correct :D

OyinOlamide · 2021-10-18T20:54:23Z

@potiuk @ephraimbuddy @uranusjr
I have updated and made the pull requests.
Please let me know if there's another way I can help or anything else I can do to get the PR merged.
Thank you!

ephraimbuddy · 2021-10-18T21:30:28Z

@potiuk @ephraimbuddy @uranusjr I have updated and made the pull requests. Please let me know if there's another way I can help or anything else I can do to get the PR merged. Thank you!

Follow the links I posted in my comment above. Locate it and change it too

OyinOlamide · 2021-10-18T22:04:54Z

@potiuk @ephraimbuddy @uranusjr I have updated and made the pull requests. Please let me know if there's another way I can help or anything else I can do to get the PR merged. Thank you!

Follow the links I posted in my comment above. Locate it and change it too

I have done that @ephraimbuddy
Those links also have pull requests now.
You can check them out below.
#19056
#19055

ephraimbuddy · 2021-10-18T22:06:47Z

@potiuk @ephraimbuddy @uranusjr I have updated and made the pull requests. Please let me know if there's another way I can help or anything else I can do to get the PR merged. Thank you!

Follow the links I posted in my comment above. Locate it and change it too

I have done that @ephraimbuddy Those links also have pull requests now. You can check them out below. #19056 #19055

Sorry, I think I got you confused.
I mean that they should be in this pull request.
Close the others and add the changes to this one

potiuk · 2021-10-18T23:40:59Z

Sorry, I think I got you confused. I mean that they should be in this pull request. Close the others and add the changes to this one

Yeah. Agree those are better together in a single PR

OyinOlamide · 2021-10-19T22:37:28Z

I think I have done that now @potiuk and @ephraimbuddy . Please take a look and let me know if there is any way I can make this better. Thank you! :)

ephraimbuddy · 2021-10-20T10:39:44Z

INSTALL

-sudo apt install build-essentials python3.6-dev python3.7-dev python-dev openssl \
-                 sqlite sqlite-dev default-libmysqlclient-dev libmysqld-dev postgresq
+sudo apt install openssl \
+                 sqlite default-libmysqlclient-dev libmysqld-dev postgresql


I think we need build-essential and libsqlite3-dev here.

Apart from the contributors quick start doc. We need this here and also in breeze.
cc: @uranusjr

Yes we do. The quick start does not need them because they are installed by a previous command, but that's not the case here.

@OyinOlamide

Also add python3-dev as well

@ephraimbuddy I did not remove libsqlite3-dev
Do you want me to add it somewhere in the code?

@ephraimbuddy Sorry, but this change is not clear. Both strips of code you mentioned in your last comment seem to be the same or am I missing something?

Sorry, I meant libmysqld-dev instead of libmysqlclient-dev.

The change should be:

sudo apt install build-essential python3-dev libsqlite3-dev openssl \ sqlite default-libmysqlclient-dev libmysqlclient-dev postgresql

@ephraimbuddy Alright, I was not aware of this before. Should this particular change take effect in all three files or just .breeze and INSTALL?

Just breeze and install

I've done that now @ephraimbuddy
Please check it out and let me know. Thank you for your patience and help.

OyinOlamide · 2021-10-20T13:27:38Z

Hello @ephraimbuddy @uranusjr @potiuk I think I have carried out these changes now. Please take a look at my last commit and let me know.
Thank you so much for your time and patience. :)

github-actions · 2021-10-20T13:28:47Z

The PR is likely ready to be merged. No tests are needed as no important environment files, nor python files were modified by it. However, committers might decide that full test matrix is needed and add the 'full tests needed' label. Then you should rebase it to the latest main or amend the last commit of the PR, and push it with --force-with-lease.

boring-cyborg · 2021-10-20T18:53:35Z

Awesome work, congrats on your first merged pull request!

potiuk · 2021-10-20T19:06:19Z

🎉 🎉 🎉 🎉 🎉 🎉

OyinOlamide · 2021-10-20T20:49:18Z

Thank you so much @potiuk , @ephraimbuddy , @uranusjr

Beyond excited about this and looking forward to doing more. 💯

uranusjr reviewed Oct 18, 2021

View reviewed changes

CONTRIBUTORS_QUICK_START.rst Outdated Show resolved Hide resolved

ephraimbuddy requested changes Oct 18, 2021

View reviewed changes

OyinOlamide added 2 commits October 19, 2021 23:02

Merge branch 'apache:main' into patch-1

05ee0a7

First commit

0d5b1a6

potiuk approved these changes Oct 19, 2021

View reviewed changes

potiuk requested a review from ephraimbuddy October 19, 2021 23:59

ephraimbuddy reviewed Oct 20, 2021

View reviewed changes

Second

9b3668c

ephraimbuddy approved these changes Oct 20, 2021

View reviewed changes

github-actions bot added the okay to merge It's ok to merge this PR as it does not require more tests label Oct 20, 2021

potiuk approved these changes Oct 20, 2021

View reviewed changes

Third

d19d86a

ephraimbuddy merged commit 326e2b1 into apache:main Oct 20, 2021

ephraimbuddy added the changelog:skip Changes that should be skipped from the changelog (CI, tests, etc..) label Apr 14, 2022

	echo " sudo apt install build-essentials python3.6-dev python3.7-dev python3.8-dev python-dev openssl \\"
	echo " sqlite sqlite-dev default-libmysqlclient-dev libmysqld-dev postgresql"

	sudo apt install build-essentials python3.6-dev python3.7-dev python-dev openssl \
	sqlite sqlite-dev default-libmysqlclient-dev libmysqld-dev postgresq

Update CONTRIBUTORS_QUICK_START.rst #19042

Update CONTRIBUTORS_QUICK_START.rst #19042

Uh oh!

Conversation

OyinOlamide commented Oct 18, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

boring-cyborg bot commented Oct 18, 2021

Uh oh!

Uh oh!

ephraimbuddy left a comment

Choose a reason for hiding this comment

Uh oh!

potiuk commented Oct 18, 2021

Uh oh!

OyinOlamide commented Oct 18, 2021

Uh oh!

ephraimbuddy commented Oct 18, 2021

Uh oh!

OyinOlamide commented Oct 18, 2021

Uh oh!

ephraimbuddy commented Oct 18, 2021

Uh oh!

potiuk commented Oct 18, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

OyinOlamide commented Oct 19, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

OyinOlamide commented Oct 20, 2021

Uh oh!

github-actions bot commented Oct 20, 2021

Uh oh!

boring-cyborg bot commented Oct 20, 2021

Uh oh!

potiuk commented Oct 20, 2021

Uh oh!

OyinOlamide commented Oct 20, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

OyinOlamide commented Oct 18, 2021 •

edited

Loading

potiuk commented Oct 18, 2021 •

edited

Loading