Added citation file

[anawas]

I added a citation file as described here:
https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files

This commit resolves issue #640.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.19%. Comparing base (599d993) to head (7e0859e).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #641   +/-   ##
=======================================
  Coverage   71.19%   71.19%           
=======================================
  Files          55       55           
  Lines        5947     5947           
=======================================
  Hits         4234     4234           
  Misses       1713     1713           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[Lukas113]

Generally LGTM

However, I'm not sure about two things:

• Firstly about the authors. Some contributors are included and others are not (e.g. you Andreas, Luis, Philip, Jennifer and Christoph). However, I'm not exactly what to do about this other than include them all? IDK.
• Secondly about the version and release date. These change with a new release and have to be updated each time, which might easily get forgotten. Are they mandatory?

[anawas]

I suggest to use the affiliation instead of a list of authors. What I can do with the cff file is:

FHNW, School of Computer Science, Institute for Data Science. (2024). Karabo (Version 0.31.0) [Computer software]. https://github.com/i4Ds/Karabo-Pipeline

The version of a software is essential for the traceability of scientific results. But I see your point that one will forget to bump it in this file. Since the cff file is a basic text file, can we generate it from a template every time we create a new release?

[Lukas113]

👍 for affiliation

ok. The best solution would be to update the version automatically in the CI from a release-event. I think this could be achieved by this workflow which does the update. However, this would just be a commit after the release. The tag would need to be moved from last-commit to current HEAD afterwards with sth like this.

So I suggest if you have time and are interested to do some CI/CD work go for it. But I understand that this is some effort to just get a little automation gain. Otherwise I suggest do adapt the doc.src.development.md "Create a Release" section to adjust the version right before a release is triggered.

[anawas]

What changed:

• The file CITIATION.cff now lists affiliation instead of individuals
• I added an action workflow that updates the version in this file when a new release is published. I followed the links in the comment by @Lukas113.

[Lukas113]

LGTM

🤞 that it works :)