Ctrl K

Amazing GitHub Research Repo

This is a showcase of all the amazing features that GitHub offers for your research project

1
contributor
25 commitsLast commit ≈ 6 months ago1 star0 forks

Cite this software

Description

Amazing GitHub Research Repo

This tiny project showcases a clean, reproducible layout for research code using Python. It demonstrates:

  • The files you should always have present to allow others to reuse and cite your project, namely a LICENSE and a CITATION.cff.
  • How you should configure your .gitignore file to never commit potentially sensitive research data.
  • How to share the project dependencies (aka requirements).
  • How to instruct other on how to set up their system and how to rerun your code.
  • How you can use Issues and Pull Requests to manage your project and collaborate with others.
  • How you can run unit tests every time you push new code to the repository so that you can spot issues early.
  • How you can safely back up your code to Zenodo whenever you create a release.
  • How you can register your project on RSD to link your project to a paper and other work.
Keywords
Programming language
  • Python 100%
License
</>Source code

Participating organisations

Tilburg University

Contributors

Related software

Tilburg University Coding Café

TI

Materials for Tilburg University's Coding Café

Updated 10 months ago
7