Developers - how to contribute #1084
ValueRaider
started this conversation in
Development
Replies: 2 comments 2 replies
-
Just an FYI, download Pandas 2.1.0 and I started getting iloc warnings while using YFinance (utils.py). It's just a matter of adding iloc[x] to the code. I added it to the library and the warnings disappeared. I downgraded to 1.5.3 and all is good while the next version of YFinance is ready. Thanks for everything, love this library. |
Beta Was this translation helpful? Give feedback.
1 reply
-
How to run tests to make sure I don't break anything? |
Beta Was this translation helpful? Give feedback.
1 reply
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Branches
To support rapid development without breaking stable versions, this project uses a two-layer branch model:
![image](https://private-user-images.githubusercontent.com/96923577/269063055-5afe5e2b-a43c-4a64-a736-a9e57fb5fe70.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjExNDc3NTIsIm5iZiI6MTcyMTE0NzQ1MiwicGF0aCI6Ii85NjkyMzU3Ny8yNjkwNjMwNTUtNWFmZTVlMmItYTQzYy00YTY0LWE3MzYtYTllNTdmYjVmZTcwLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MTYlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzE2VDE2MzA1MlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWZiZTE4MjcyNWZhNDM3ODY1MzA1NTZiM2E1NjRkOTNmN2M4N2QxNGQyMGI3ZTdiMDU1ZmM4MGQzNWJiYTAyNmQmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.KMyD_YbmkWEhVT1b5st7blKODgRX3jFrUT4awt-RwPw)
(inspiration)
Most of the time you want to target the dev branch, but default is main so remember to switch to dev.
Exception: can straight merge into main if:
I'm a GitHub newbie, how do I contribute?
Sync fork
How to download & run a GitHub version of yfinance
Unit tests
Tests have been written using the built-in Python module
unittest
. Examples:Run all price tests:
python -m unittest tests.test_prices
Run sub-set of price tests:
python -m unittest tests.test_prices.TestPriceRepair
Run a specific test:
python -m unittest tests.test_prices.TestPriceRepair.test_ticker_missing
Run all tests:
python -m unittest discover -s tests
Git stuff
commits
To keep the Git commit history and network graph compact please follow these two rules:
git commit -m "short sentence summary" -m "full commit message"
squash
tiny/negligible commits back with meaningful commits, or to combine successive related commits. Guide but basically it's:rebase
You might be asked to move your branch from
main
todev
. Make sure you have pulled all relevant branches then run:Beta Was this translation helpful? Give feedback.
All reactions