Define best practises that we're looking for #28
Description
Can we generate a simple list of best practises we're looking for? We're interested to investigate examples in the eLife corpus.
My starting list, for feedback and discussion:
- code is shared by researcher via a repository
- this repo URL still resolves
and in this repo: - license is defined
- citation file
- readme
- contributing guidelines [is this an optional extra?]
- evidence that code has been reviewed / outputs have been reproduced [is this a next step best practise for research code?]
- test coverage ??
- commenting coverage ?? [how else to measure how well-documented the code is?]
plus: - archived deposit that relates to version of record publication --> particularly if original repo URL no longer resolves