Files
NexQuant/.github/PULL_REQUEST_TEMPLATE.md
T
TPTBusiness b98c9cd572 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
2026-04-11 21:40:18 +02:00

92 lines
2.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Pull Request
## Beschreibung
<!--
Eine klare und prägnante Beschreibung der Änderungen.
Beziehe dich auf das zugehörige Issue (falls vorhanden).
-->
**Fixes:** #<!-- Issue-Nummer -->
## Typ
<!-- Bitte zutreffendes ankreuzen [x] -->
- [ ] 🐛 Bug Fix
- [ ] ✨ Neue Funktion
- [ ] 📚 Dokumentation
- [ ] 🧹 Code Cleanup/Refactoring
- [ ] ⚡ Performance-Verbesserung
- [ ] 🔧 Konfiguration/Build
- [ ] 🧪 Tests
## Changes
<!-- Welche Dateien wurden geändert und warum? -->
- `Datei1.py`: Beschreibung der Änderung
- `Datei2.py`: Beschreibung der Änderung
## Testing
<!-- Wie wurden die Änderungen getestet? -->
### Tests hinzugefügt/aktualisiert
- [ ] Ja, Unit Tests
- [ ] Ja, Integration Tests
- [ ] Nein, aber manuell getestet
- [ ] Nicht zutreffend
### Testing Notes
<!-- Beschreibe deine Testing-Schritte -->
```bash
# Beispiel: Tests ausführen
pytest test/ -v --cov=rdagent
# Beispiel: CLI Command testen
rdagent COMMAND --help
```
## Checklist
<!-- Bitte alle zutreffenden Punkte ankreuzen [x] -->
- [ ] Meine Änderungen folgen dem [Coding Style](CONTRIBUTING.md)
- [ ] Ich habe [CONTRIBUTING.md](CONTRIBUTING.md) gelesen und befolgt
- [ ] Tests wurden hinzugefügt oder aktualisiert
- [ ] Dokumentation wurde aktualisiert (`docs/` oder README.md)
- [ ] CHANGELOG.md wurde aktualisiert (falls zutreffend)
- [ ] Pre-commit Hooks bestanden (`pre-commit run --all-files`)
- [ ] Keine closed-source Assets committen (siehe unten)
## ⚠️ Closed-Source Check
<!--
KRITISCH: Bitte bestätige, dass KEINE der folgenden Dateien committen wurden:
-->
- [ ] `git_ignore_folder/` Trading-Skripte, OHLCV-Daten, Credentials
- [ ] `results/` Backtest-Ergebnisse, Strategien, Logs
- [ ] `.env` API-Keys, Credentials
- [ ] `models/local/` Eigene verbesserte Modelle
- [ ] `prompts/local/` Eigene verbesserte Prompts
- [ ] `rdagent/scenarios/qlib/local/` Closed-Source Komponenten
- [ ] `*.db` SQLite-Datenbanken
- [ ] `*.log` Log-Files
## Screenshots (falls relevant)
<!-- Vorher/Nachher-Vergleiche, UI-Änderungen etc. -->
| Vorher | Nachher |
|--------|---------|
| <!-- Screenshot --> | <!-- Screenshot --> |
## Zusätzliche Kontext
<!-- Weitere Informationen zu den Änderungen -->