feat: Add GitHub infrastructure, CI/CD pipelines, and examples

- Add GitHub issue templates (bug, feature, docs)
- Add pull request template with closed-source checklist
- Add CODEOWNERS for code review assignment
- Add CI/CD workflows (ci, lint, security, docs, release)
  - pytest + coverage with Python 3.10/3.11 matrix
  - Ruff + MyPy code quality checks
  - Bandit + safety security scanning
  - Sphinx docs + GitHub Pages deployment
  - Automated PyPI releases on tag push
- Add 6 comprehensive examples + Jupyter quickstart
  - 01_factor_discovery.py (LLM factor generation)
  - 02_factor_evolution.py (factor optimization)
  - 03_strategy_generation.py (IC-weighted combination)
  - 04_backtest_simple.py (strategy backtesting)
  - 05_model_training.py (XGBoost/LSTM training)
  - 06_rl_trading_agent.py (PPO/DQN/A2C agents)
  - notebooks/quickstart.ipynb (interactive tutorial)
- Restructure .gitignore with explicit closed-source sections
- Add CI/coverage/license badges to README
- Complete CLI docstrings for all 9 commands
- Add data_config.yaml for quant loop configuration
This commit is contained in:
TPTBusiness
2026-04-11 21:40:18 +02:00
parent b42627c335
commit 5738e47ffa
23 changed files with 3275 additions and 175 deletions
+58
View File
@@ -0,0 +1,58 @@
---
name: 🐛 Bug Report
about: Create a report to help us improve PREDIX
title: '[Bug] '
labels: 'bug, needs-triage'
assignees: ''
---
## Beschreibung
<!-- Eine klare und prägnante Beschreibung des Bugs -->
## Reproduktionsschritte
<!-- Schritte zum Reproduzieren des Verhaltens -->
1. Schritt 1: `...`
2. Schritt 2: `...`
3. Schritt 3: `...`
4. Fehler tritt auf
## Erwartetes Verhalten
<!-- Eine klare Beschreibung dessen, was passieren sollte -->
## Tatsächliches Verhalten
<!-- Was passiert tatsächlich? -->
## Environment
<!-- Bitte fülle die folgenden Informationen aus -->
- **OS:** [z.B. Linux, macOS, Windows]
- **Python-Version:** [z.B. 3.10, 3.11]
- **PREDIX-Version:** [z.B. v2.0.0, main-branch]
- **Installation:** [z.B. pip, conda, from source]
## Logs & Screenshots
<!-- Füge relevante Logs oder Screenshots hinzu -->
<details>
<summary>Log Output (klicken zum Aufklappen)</summary>
```
Hier die Log-Ausgabe einfügen
```
</details>
## Zusätzliche Kontext
<!-- Weitere Informationen zum Problem -->
### Data Configuration
- [ ] Ich habe sichergestellt, dass die Daten korrekt geladen sind
- [ ] `qlib init` wurde erfolgreich ausgeführt
### Workaround
<!-- Falls vorhanden: Gibt es einen Workaround? -->
@@ -0,0 +1,47 @@
---
name: 💡 Feature Request
about: Suggest an idea for PREDIX
title: '[Feature] '
labels: 'enhancement, needs-triage'
assignees: ''
---
## Problem-Beschreibung
<!-- Bezieht sich dein Feature auf ein Problem? Bitte beschreibe es -->
<!-- Beispiel: "Ich bin immer frustriert, wenn ich..." -->
## Lösungsvorschlag
<!-- Eine klare und prägnante Beschreibung dessen, was du gerne hättest -->
## Alternativen
<!-- Hast du alternative Lösungen in Betracht gezogen? -->
## Zusätzliche Kontext
<!-- Weitere Informationen, Screenshots oder Mockups -->
## Use Case
<!-- Wie würde dieses Feature deinen Workflow verbessern? -->
### Checkliste
<!-- Bitte bestätige die folgenden Punkte mit [x] -->
- [ ] Ich habe die [Dokumentation](https://github.com/nico/Predix/tree/main/docs) gelesen
- [ ] Ich habe geprüft, ob dieses Feature bereits als [bestehendes Issue](https://github.com/nico/Predix/issues) existiert
- [ ] Dieses Feature ist relevant für **Open-Source** (keine closed-source Komponenten)
## Impact
<!-- Wer würde von diesem Feature profitieren? -->
- [ ] Alle PREDIX-Nutzer
- [ ] Spezifische Nutzer (z.B. FX-Trader, Qlib-Nutzer)
- [ ] Entwickler/Contributors
## Priorität
<!-- Wie dringend ist dieses Feature? -->
- [ ] Niedrig (Nice-to-have)
- [ ] Mittel (Würde den Workflow verbessern)
- [ ] Hoch (Blockiert meine Arbeit)
@@ -0,0 +1,58 @@
---
name: 📚 Documentation Improvement
about: Suggest improvements to PREDIX documentation
title: '[Docs] '
labels: 'documentation'
assignees: ''
---
## Aktueller Zustand
<!-- Welche Seite/Welcher Teil der Dokumentation ist betroffen? -->
**URL/Datei:** `z.B. README.md, docs/quickstart.rst`
**Aktueller Inhalt:**
<!-- Zitat oder Beschreibung des aktuellen Zustands -->
## Verbesserungsvorschlag
<!-- Was sollte geändert/hinzugefügt werden? -->
## Beispiel/Begründung
<!-- Warum ist diese Verbesserung notwendig? -->
### Art der Verbesserung
- [ ] Tippfehler/Grammatik
- [ ] Fehlende Erklärung
- [ ] Veraltetes Beispiel
- [ ] Neues Beispiel hinzufügen
- [ ] Struktur/Navigation verbessern
- [ ] API-Dokumentation erweitern
- [ ] Troubleshooting-Sektion
## Betroffene Nutzergruppe
<!-- Wer profitiert von dieser Verbesserung? -->
- [ ] Neueinsteiger
- [ ] Fortgeschrittene Nutzer
- [ ] Developers/Contributors
- [ ] Alle
## Vorschlag (Optional)
<!-- Hast du bereits einen konkreten Formulierungsvorschlag? -->
<details>
<summary>Vorgeschlagener Text (klicken zum Aufklappen)</summary>
```markdown
Hier den verbesserten Text einfügen
```
</details>
## Zusätzliche Kontext
<!-- Weitere Informationen -->