codecheckers / codecheckers/discussion
Clarifying Zenodo upload / codecheck directory / codecheck repo
- Dominant language
- No language data
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
The [CODECHECK bundle](https://codecheck.org.uk/guide/bundle) is described as:
> The CODECHECK bundle includes all files that the codechecker used to conduct the CODECHECK. This may include a copy of the author’s files, and any additional files that the codechecker created to assisst them in their codecheck.
I understand that this is not formally specified intentionally, but from the above description I'd expect that the CODECHECK bundle actually refers to the full repository clonded unter the codecheckrs org, since the code and figures provided by the authors are certainly part of the "files that the codechecker used to conduct the CODECHECK". On the other hand, the community guide rather seems to imply that the CODECHECK bundle only refers to things in the `codecheck` directory. Some Zenodo uploads only contain the `codecheck.pdf` file, some additionally have some contents of the `codecheck` directory, but I did not see any that actually contained the `output` directory let alone all the code/figures provided by the original authors.
I feel that it would make sense to have more consistency in this. Also, choosing some files by hand also in principle makes it possible to upload different versions that are inconsistent with the ones in the repository. In my opinion, it would be best to either only upload the `codecheck.pdf` file to Zenodo (similar to the [ReScience C](https://rescience.github.io) approach), or use the github Zenodo connection and make a release of the full repository that then gets automatically uploaded to Zenodo (not sure whether this works with a reserved DOI, though).
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.