Forked from
R3 / school / courses
383 commits behind the upstream repository.
-
Laurent Heirendt authoredLaurent Heirendt authored
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
qualityCode.md 1004 B
Quality of computer code is relevant for everyone.
This does not concern me – I am only writing documentation or a script for generating a figure that I want to publish!
[Anonymous researcher]
Great, but ...
- Figure may not be reproducible
- Figure looks different when the input data changes
- Documentation will become outdated
… actually, EVERYONE writing documentation, a script, or code is concerned!
Attributes of high-quality computer code
Quality of computer code can be seen as a group of various attributes.
High-quality computer code should be:
- Versioned: incremental code
- Well-written (formatted, documented, commented): easy to read by a human
- Tested: extensively tested code