Menü der Dokumentation
Die Prüfungen in jedem RepoReady-Bericht
Berichte ordnen Befunde aus statischen Prüfungen und KI-Review in vier Bereiche. Die Leitfäden zeigen, wie gute Praxis aussieht und wie Sie Lücken beheben.
Zuletzt aktualisiert
Bericht
- 1Execution
- 2Data & Results
- 3Code Health
- 4Manuscriptmit Manuskript
Execution
Was andere brauchen, um Ihre Softwareumgebung aufzusetzen und Ihre Analyse von den Daten bis zu den Ergebnissen nachzuvollziehen.
Data & Results
Woher Daten stammen, wie sie verarbeitet werden und wie Ergebnisse und Notebooks abgelegt sind.
- Data Integrity
- Data Provenance
- Result Artifacts
- Notebook Quality
Code Health
Dokumentation, Code-Struktur, Tests, Sicherheit und Ordnung im Repository.
- Documentation Quality
- Code Clarity
- Testing
- Hidden Issues & Security
- Repository Hygiene
Manuscript
Ob Manuskript und Code übereinstimmen: Methoden, Aussagen, Abbildungen und Statistik. Enthalten, wenn Sie ein Manuskript hinzufügen.
Wie Befunde eingestuft sind
| Schweregrad | Bedeutung |
|---|---|
| Critical | Verhindert, dass andere zentrale Ergebnisse reproduzieren; zuerst beheben. |
| Warning | Ein spürbares Risiko für die Reproduzierbarkeit. |
| Improvement | Eine kleinere Lücke, deren Behebung sich lohnt. |
| Good | Entspricht guter Praxis. |
| Info | Kontext oder etwas, das sich nicht bewerten ließ. |