Review Brokerage Repo Readmes
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 42/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation, tooling
Research direction
Start by reviewing the Coinbase README and the brokerage and dataset repository READMEs, noting outdated terminal output, deployment steps, and broken links. Then locate the automated link checker mentioned in the issue; done means the README information is current, links work, and those repositories are covered by the checker.
Written by the indexing model from the issue text.
Description
Expected Behavior
The brokerage repo readmes (example) have up-to-date information and all links are functional
Actual Behavior
These brokerage repo readmes fall out-of-date over time. For example, one of the terminal outputs on the Coinbase repo includes brokerages that we don't even support anymore.
$ lean live 'My Project'
Select a brokerage:
1. Paper Trading
2. Interactive Brokers
3. Tradier
4. OANDA
5. Bitfinex
6. Coinbase Pro
7. Binance
8. Zerodha
9. Samco
10. Terminal Link
11. Atreyu
12. Trading Technologies
13. Kraken
14. FTX
Enter an option:
The Coinbase repo even includes steps in the deployment process that are no longer required. For example, the deployment wizard support existing holdings now, but the repo doesn't reflect this.
Moreover, the readmes have broken links. We should extend the automated link checker to scan the links on these brokerage/dataset repos.
Checklist
- I have completely filled out this template
- I have confirmed that this issue exists on the current
masterbranch - I have confirmed that this is not a duplicate issue by searching issues
- Dominant language
- HTML
- Stars
- 263
- Forks
- 191
- Avg merge
- 1h 22m
- Merged PRs (30d)
- 80
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from QuantConnect/Documentation
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 85/100
QuantConnect/Documentation#2758 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
QuantConnect/Documentation#2670 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
QuantConnect/Documentation#2139 · 1 reaction ·
Maintainers usually reply within 1 day
-
Review the Data Analyser ClassMay be free again @DerekMelchin claimed this 454 days ago, and no pull request is open. Open
QuantConnect/Documentation#2120 · 1 assignee ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 52/100
QuantConnect/Documentation#1800 ·
Maintainers usually reply within 1 day
All issues in QuantConnect/Documentation
Similar issues
-
mxl-compile: пример заполнения ячеек отклоняется UnicaPossibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 1/5 1-3 hours Newbie friendliness 91/100
IngvarConsulting/unica#1301 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 82/100
siyuan-note/siyuan#20313 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 82/100
gofish-graphics/gofish-graphics#1084 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 76/100
ethereum/execution-apis#935 ·
Maintainers usually reply within 1 day