Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #975 +/- ##
=======================================
Coverage 86.76% 86.76%
=======================================
Files 69 69
Lines 3694 3694
=======================================
Hits 3205 3205
Misses 489 489 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR updates the repository’s top-level documentation to include citation guidance now that FROG has a Zenodo release/DOI, making it easier for researchers to properly reference the software.
Changes:
- Add a Zenodo DOI badge alongside existing project status badges.
- Add a “Citing this software” section linking to Zenodo for citation details.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Description
Now that we have a release published on Zenodo 🥳, we should give instructions on how to cite the code. Add instructions to the readme as well as a badge for the DOI corresponding to the latest version.
Closes #974.
Type of change
Key checklist
pre-commit run -a)pytest)mkdocs build -s)pyinstaller-built executable works (if relevant)Further checks