goldyard/yfinance-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix dev branch install command

Browse Source
This commit is contained in:
Tony Gao
2026-03-27 09:57:35 -04:00
parent 3fcefb92d9
commit 36b73f57ab
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+7 -7
View File
@@ -8,13 +8,13 @@ This is a quick short guide, full guide at https://ranaroussi.github.io/yfinance
YFinance uses a two-layer branch model: YFinance uses a two-layer branch model:
* **dev**: new features & most bug-fixes merged here, tested together, conflicts fixed, etc. - **dev**: new features & most bug-fixes merged here, tested together, conflicts fixed, etc.
* **main**: stable branch where PIP releases are created. - **main**: stable branch where PIP releases are created.
## Running a branch ## Running a branch
```bash ```bash
pip install git+ranaroussi/yfinance.git@dev # <- dev branch pip install "git+https://github.com/ranaroussi/yfinance.git@dev" # <- dev branch
``` ```
https://ranaroussi.github.io/yfinance/development/running.html https://ranaroussi.github.io/yfinance/development/running.html
@@ -41,11 +41,11 @@ https://ranaroussi.github.io/yfinance/development/documentation.html
Help keep the Git commit history and [network graph](https://github.com/ranaroussi/yfinance/network) compact: Help keep the Git commit history and [network graph](https://github.com/ranaroussi/yfinance/network) compact:
* got a long descriptive commit message? `git commit -m "short sentence summary" -m "full commit message"` - got a long descriptive commit message? `git commit -m "short sentence summary" -m "full commit message"`
* combine multiple commits into 1 with `git squash` - combine multiple commits into 1 with `git squash`
* `git rebase` is your friend: change base branch, or "merge in" updates - `git rebase` is your friend: change base branch, or "merge in" updates
https://ranaroussi.github.io/yfinance/development/code.html#git-stuff https://ranaroussi.github.io/yfinance/development/code.html#git-stuff
@@ -53,7 +53,7 @@ https://ranaroussi.github.io/yfinance/development/code.html#git-stuff
Tests have been written using the built-in Python module `unittest`. Examples: Tests have been written using the built-in Python module `unittest`. Examples:
* Run all tests: `python -m unittest discover -s tests` - Run all tests: `python -m unittest discover -s tests`
https://ranaroussi.github.io/yfinance/development/testing.html https://ranaroussi.github.io/yfinance/development/testing.html