Closed lukavdplas closed 9 months ago
Excellent idea, and I like the provided template. The developer information we currently have could maybe be moved to a CONTRIBUTING.md?
The github documentation on contributing.md suggests
So it's more a code of conduct than technical documentation.
In my experience, contributing.md is definitely also a "how to develop". A code of conduct is a different beast, that's why you put a link to it in the contributing.md.
The template readme lists a lot of the technical details for developers and little else, which makes sense: other information is usually project specific. But the result is that we often end up using the existing readme as a "template" and keep the same basic structure.
A specific effect is that many of our readmes are structured like
where it's missing the information that this is a web application and those prerequisites are mostly for development/deployment, and that the rest of the readme is not a user manual but a development manual.
We can use this template as a basis instead: https://github.com/UtrechtUniversity/FAIR-Cheatsheets/blob/main/cheatsheets/FAIR_code_publishing/README_FAIR_code_publishing.md
Personally I would support: