Project assessment with focus on research software/open science aspects
I did an assessment with the recommendations regarding research software in mind. Here are my suggestions (some of them I will apply via PR later on, marked with (PR)):
-
Readme/Documentation: Add a short statement right in the beginning who will/should be the users of SaQC -
Readme/Documentation: Try to describe your software in 1-2 sentences only right in the beginning -
Documentation: Already any existing case studies for your software? If there is no 'real live' example yet try describe a common workflow -
Readme (PR): Add Sections: Changelog (just in case: https://keepachangelog.com/), Contributing, Copyright and License, Acknowledgements, Repo Status (https://www.repostatus.org/) -
Add citation.cff to Repo (PR) (https://citation-file-format.github.io/) -
Documentation: if applicable add any troubleshooting information -
Readme/Documentation: Add information how a user can get help/report issues (contact, wiki, gitlab, mailing list etc) -
Do you support your (future) users in any way? I guess there is no initial plan for that yet, UFZ users maybe? Maybe a user support email address? -
Tags are not described/release notes (just link them tags later to the changelog :) -
Documentation: You probably have any dependencies that should be listed here -
Twitter: when you officially release, just give me a shot and I will do the promotion limbo on twitter :) -
Readme: Add Section: Publications (applicable in the future, I guess :), How to cite -
Source code files: copyright information in each file header recommended -
CLA - Contributor license agreement - something for the future to think about (if not done already), especially when using GPL (http://contributoragreements.org/ https://cla-assistant.io/)
Edited by David Schäfer