Skip to content

Add a CITATION.cff file #2532

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add a CITATION.cff file #2532

wants to merge 1 commit into from

Conversation

Shrinks99
Copy link
Member

@Shrinks99 Shrinks99 commented Apr 4, 2025

GitHub has a cool feature that lets people more easily cite your project! This is especially relevant for reference managers like Zotero which will pull this data automatically. Occasionally researchers and academics will use Browsertrix (or Browsertrix Crawler) — it would be nice for them to cite the correct tool! This (hopefully) helps them do that :)

Changes

  • Adds a CITATION.cff file
  • Updates the update-version.sh script to also update the citation file with the correct version number

Future

Could add this for Webrecorder's other repos to encourage proper software citations for Webrecorder's other work, though they don't have update scripts like Browsertrix does so this introduces extra complexity in the version number update process unless those scripts are created.

- Updates the `update-version.sh` script to also update the citation file with the correct version number
@ikreymer
Copy link
Member

ikreymer commented Apr 9, 2025

Does the version number really need to be in the citation file? Chances are, someone is just citing Browsertrix in general, not a specific release..

@Shrinks99
Copy link
Member Author

Generally yes! It's best practice to cite a specific release when you are citing software because software changes over multiple releases. Ultimately this is up to the academic & referencing style, but including it here in the citation information means that it can be propagated to the desired reference format, whatever that may be.

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.

2 participants