Complete the NFDI4Earth project checklist
https://nfdi4earth.pages.rwth-aachen.de/architecture/devguide/projects/
Checklist
-
Have a README.md file (see below for contents) -
Have user and developer documentation -
Have a LICENSE file in the repository, see Licensing -
Keep a list of all contributors to a project -
Have a (minimal) CI/CD configuration that at least runs one test -
Have copyright and licensing information in each file, see https://reuse.software/tutorial/; note that the copyright holder is generally the institutions, e.g., "Technische Universität Dresden" possibly with an addition "Chair of Geoinformatics" -
Have a CHANGELOG.md, see https://keepachangelog.com/en/1.0.0/ -
Use semantic versioning in form of git tags and in the CHANGELOG -
Publish releases to Zenodo
README checklist¶
-
Add badges as suitable (DOI, Zenodo, CI, ...), including project lifecycle badge -
Short project description, ideally also with visuals, e.g., screenshot or image, including main features -
Section Installation -
Section Usage, incl. information for configuration, logging (possibly as subsections) -
Section Development giving hints on how to set up a development environment, possibly with subsections (e.g., building, dev dependencies, debugging tricks, creating a release, ...) -
Section Contributing to help people contribute (Are tests required? Open issue before MR?), if this is more than a few sentences, have a CONTRIBUTING.mf -
Contact information (name and email) -
List of contributors, consider using the All Contributors tool also on GitLab -
Optional: "How to cite" if the project has a DOI -
Acknowledgement of NFDI4Earth funding, see https://nfdi4earth.de/member-area/faq -
Section License, which has detailed information on licensing of software, data, and text, for example https://github.com/hifis-net/RSD-as-a-service#license
Edited by Daniel Nüst