KIT | KIT-Bibliothek | Impressum | Datenschutz

A concise guide to good practices for automated testing and documentation of Research Software

Fritz, Jakob; Mesiti, Michele 1; Thiele, Jan Philipp
1 Scientific Computing Center (SCC), Karlsruher Institut für Technologie (KIT)

Abstract:

This publication aims to highlight aspects of good practices from the areas of testing, documentation, and workflow management to improve existing code in Research.
Applying these practices helps to make the scientific results obtained with the software easier to reproduce, as the codebase is easier to understand (thanks to documentation) and it is ensured that the code works as expected (thanks to automated testing). As codebases grow larger, workflow management for automated testing is also needed in order to keep the development cycle fast.


Verlagsausgabe §
DOI: 10.5445/IR/1000183930
Veröffentlicht am 11.08.2025
Originalveröffentlichung
DOI: 10.14279/eceasst.v83.2622
Cover der Publikation
Zugehörige Institution(en) am KIT Scientific Computing Center (SCC)
Publikationstyp Zeitschriftenaufsatz
Publikationsjahr 2025
Sprache Englisch
Identifikator ISSN: 1863-2122
KITopen-ID: 1000183930
HGF-Programm 46.21.02 (POF IV, LK 01) Cross-Domain ATMLs and Research Groups
Erschienen in Electronic communications of the EASST
Verlag Technische Universität Berlin, Universitätsbibliothek
Band 83
Bemerkung zur Veröffentlichung deRSE24 - Selected Contributions of the 4th Conference forResearch Software Engineering in Germany
Vorab online veröffentlicht am 21.02.2025
Schlagwörter Ci, documentation, testing, workflows, RSE
Nachgewiesen in Scopus
OpenAlex
KIT – Die Universität in der Helmholtz-Gemeinschaft
KITopen Landing Page