Idea: provide strict rules to use README files

[vkush]

Some repositories (e.g. bonndata) are using internal policy to force users to create README files within data sets with a proper description inside (as an additional information, how to use the data set, how to rerun this experiment, etc.).

Some links, which can be useful, if we also go on similar way:

• Lang, K. (2023, Januar 25). Coffee Lecture Slides: Description of Research Data – The creation of codebooks and README files. Zenodo. https://doi.org/10.5281/zenodo.7569118
  • Public Licence Selector (EUDAT)
  • Choose a Licence (GitHub)
  • Data Documentation (University of Arizona, Data Cooperative)
  • readme template (UA Research Data Repository)
  • Lizenzen / Forschungsdaten veröffentlichen (forschungsdaten.info)
  • Tree view of a directory/folder in Windows? (Stackoverflow.com)
• Lang, K., 2024. Readme-Template für die Dokumentation von Forschungsdatensätzen. https://doi.org/10.71758/refodat.24

[dalito]

In my opinion, writing READMEs is a more a topic for teaching than it is a feature request. - ...except if you think about a README-service that creates READMEs for the users with an LLM agent.