Skip to content

feat: add examples/ folder, CONTRIBUTING.md, Norgate export script, a…#25

Open
Suriya-002 wants to merge 1 commit intomainfrom
feat/examples-and-contributing
Open

feat: add examples/ folder, CONTRIBUTING.md, Norgate export script, a…#25
Suriya-002 wants to merge 1 commit intomainfrom
feat/examples-and-contributing

Conversation

@Suriya-002
Copy link
Collaborator

Tasks 1 & 11 from the contributor task list.
examples/ folder (Task 1):

3 strategy examples with heavy inline comments (SMA trend filter, volume spike entry, gap-up overnight with SPY regime filter)
3 config examples (single symbol quick test, Nasdaq 100 portfolio run, stress test with noise/sweep/block MC)
1 Jupyter notebook showing ML feature classification workflow on ml_features.parquet

CONTRIBUTING.md (Task 11):

Dev environment setup, how to add a strategy (4-step plugin process), how to run the test suite, PR checklist

Norgate export script:

scripts/norgate_to_parquet.py — uses the existing services/norgate_service.py wrapper to iterate over a watchlist and export OHLCV to parquet

Tests:

tests/test_example_strategies.py — 15 tests covering all 3 example strategies (15/15 passing)
pytest tests/test_example_strategies.py -v → all green

@Suriya-002 Suriya-002 requested a review from zachisit March 18, 2026 19:35
@zachisit zachisit assigned zachisit and Suriya-002 and unassigned zachisit Mar 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants