From 36b73f57ab62476c390690184977e16e35d0321c Mon Sep 17 00:00:00 2001 From: Tony Gao Date: Fri, 27 Mar 2026 09:57:35 -0400 Subject: [PATCH] docs: fix dev branch install command --- CONTRIBUTING.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 632f100..1dfacad 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: -* **dev**: new features & most bug-fixes merged here, tested together, conflicts fixed, etc. -* **main**: stable branch where PIP releases are created. +- **dev**: new features & most bug-fixes merged here, tested together, conflicts fixed, etc. +- **main**: stable branch where PIP releases are created. ## Running a branch ```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 @@ -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: -* 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 @@ -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: -* 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