Skip to content

Add CITATION.cff#11475

Merged
ofahimIQSS merged 1 commit intodevelopfrom
10187-citation.cff
Jun 23, 2025
Merged

Add CITATION.cff#11475
ofahimIQSS merged 1 commit intodevelopfrom
10187-citation.cff

Conversation

@pdurbin
Copy link
Copy Markdown
Member

@pdurbin pdurbin commented May 7, 2025

What this PR does / why we need it:

We want people to cite this paper:
https://doi.org/10.1177/0049124107306660

Generated using cffinit linked from here:
https://citation-file-format.github.io

Which issue(s) this PR closes:

Special notes for your reviewer:

No version because it's always changing.

Should we add the title of the paper? 🤔 Maybe under "description of the DOI"? Here's a screenshot:

Screenshot 2025-05-07 at 4 06 55 PM

Suggestions on how to test this:

After merging, we should see a "cite this repository" button on GitHub, as on this repo: https://github.com/citation-file-format/ruby-cff

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

No.

Is there a release notes update needed for this change?:

I didn't add one. 🤷

Additional documentation:

None.

We want people to cite this paper:
https://doi.org/10.1177/0049124107306660

No version because it's always changing.

Generated using cffinit linked from here:
https://citation-file-format.github.io
@pdurbin pdurbin moved this to Ready for Review ⏩ in IQSS Dataverse Project May 7, 2025
@github-actions github-actions bot added Size: 3 A percentage of a sprint. 2.1 hours. Type: Feature a feature request labels May 7, 2025
@pdurbin pdurbin added the FY24 Sprint 23 FY24 Sprint 23 label May 7, 2025
@cmbz cmbz added FY25 Sprint 23 FY25 Sprint 23 (2025-05-07 - 2025-05-21) and removed FY24 Sprint 23 FY24 Sprint 23 labels May 7, 2025
@jp-tosca jp-tosca requested a review from Copilot May 13, 2025 15:10
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 adds a new CITATION.cff file aimed at enabling a "cite this repository" button on GitHub.

  • Adds citation metadata for using the repository for proper citation.
  • Generates the file using cffinit with required metadata fields.
Comments suppressed due to low confidence (1)

CITATION.cff:2

  • [nitpick] The title field currently contains 'Dataverse', but the PR description suggests citing a paper. Consider updating the title to include the actual paper title or clarifying the intent of the citation metadata.
title: Dataverse

@cmbz cmbz added the FY25 Sprint 24 FY25 Sprint 24 (2025-05-21 - 2025-06-04) label May 22, 2025
@cmbz cmbz added the FY25 Sprint 25 FY25 Sprint 25 (2025-06-04 - 2025-06-18) label Jun 4, 2025
@cmbz cmbz added the FY25 Sprint 26 FY25 Sprint 26 (2025-06-18 - 2025-07-02) label Jun 19, 2025
Copy link
Copy Markdown
Member

@qqmyers qqmyers left a comment

Choose a reason for hiding this comment

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

Looks like a useful improvement that can be easily changed if adding the paper title or other changes are desired. I'll go ahead and approve so this can go forward and QA can verify they button appears.

@github-project-automation github-project-automation bot moved this from Ready for Review ⏩ to Ready for QA ⏩ in IQSS Dataverse Project Jun 20, 2025
@ofahimIQSS
Copy link
Copy Markdown
Contributor

looks good, merging.

@ofahimIQSS ofahimIQSS merged commit e5bea5a into develop Jun 23, 2025
8 checks passed
@github-project-automation github-project-automation bot moved this from Ready for QA ⏩ to Merged 🚀 in IQSS Dataverse Project Jun 23, 2025
@ofahimIQSS ofahimIQSS deleted the 10187-citation.cff branch June 23, 2025 18:58
@pdurbin pdurbin added this to the 6.7 milestone Jun 23, 2025
@pdurbin
Copy link
Copy Markdown
Member Author

pdurbin commented Jun 23, 2025

Now we can see the "cite this repository" button:

Screenshot 2025-06-23 at 15-45-51 GitHub - IQSS_dataverse Open source research data repository software

@scolapasta scolapasta moved this from Merged 🚀 to Done 🧹 in IQSS Dataverse Project Jun 24, 2025
@cmbz cmbz added the FY26 Sprint 1 FY26 Sprint 1 (2025-07-02 - 2025-07-16) label Jul 2, 2025
@cmbz cmbz added the FY26 Sprint 4 FY26 Sprint 4 (2025-08-13 - 2025-08-27) label Aug 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FY25 Sprint 23 FY25 Sprint 23 (2025-05-07 - 2025-05-21) FY25 Sprint 24 FY25 Sprint 24 (2025-05-21 - 2025-06-04) FY25 Sprint 25 FY25 Sprint 25 (2025-06-04 - 2025-06-18) FY25 Sprint 26 FY25 Sprint 26 (2025-06-18 - 2025-07-02) FY26 Sprint 1 FY26 Sprint 1 (2025-07-02 - 2025-07-16) FY26 Sprint 4 FY26 Sprint 4 (2025-08-13 - 2025-08-27) Size: 3 A percentage of a sprint. 2.1 hours. Type: Feature a feature request

Projects

Status: Done 🧹

Development

Successfully merging this pull request may close these issues.

Idea: Add CITATION.cff file for Dataverse

6 participants