Skip to content

Add info on citing FROG to README.md#975

Merged
alexdewar merged 4 commits intomainfrom
add-citing-info-to-readme
Apr 23, 2026
Merged

Add info on citing FROG to README.md#975
alexdewar merged 4 commits intomainfrom
add-citing-info-to-readme

Conversation

@alexdewar
Copy link
Copy Markdown
Collaborator

@alexdewar alexdewar commented Apr 22, 2026

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

  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Documentation (non-breaking change that adds or improves the documentation)
  • Optimisation (non-breaking, back-end change that speeds up the code)

Key checklist

  • Pre-commit hooks run successfully (pre-commit run -a)
  • All tests pass (pytest)
  • The documentation builds without warnings (mkdocs build -s)
  • Check the GUI still works (if relevant)
  • Check the code works with actual hardware (if relevant)
  • Check the pyinstaller-built executable works (if relevant)

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests have been added or an issue has been opened to tackle that in the future. (Indicate issue here: # (issue))

Copilot AI review requested due to automatic review settings April 22, 2026 10:33
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 22, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.76%. Comparing base (d9bc90f) to head (0ce8c3e).
⚠️ Report is 5 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 22, 2026 10:40
@alexdewar alexdewar requested a review from dc2917 April 22, 2026 10:41
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md
Copy link
Copy Markdown
Contributor

@dc2917 dc2917 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@alexdewar alexdewar merged commit 1403b26 into main Apr 23, 2026
11 checks passed
@alexdewar alexdewar deleted the add-citing-info-to-readme branch April 23, 2026 08:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add DOI and instructions on citing to readme

3 participants