This is a showcase of all the amazing features that GitHub offers for your research project
# 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](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) and [Pull Requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-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.