Skip to content
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

Fix Ginkgo version in CITATION.cff #1625

Merged
merged 1 commit into from
Jul 2, 2024
Merged

Fix Ginkgo version in CITATION.cff #1625

merged 1 commit into from
Jul 2, 2024

Conversation

greole
Copy link
Collaborator

@greole greole commented Jun 17, 2024

The version in CITATION.cff is not the most recent, this PR bumps the version to the latest released version 1.8.0.

@greole greole requested a review from tcojean June 17, 2024 08:56
@tcojean
Copy link
Member

tcojean commented Jun 17, 2024

I always wondered if we should bump the version or not in the citation. My feeling would be not, because the paper doesn't reflect the library content and capacity of version 1.8.0, it maybe does up to 1.3.0 or something like this, in fact.

@greole
Copy link
Collaborator Author

greole commented Jun 17, 2024

Ah I see your point. I thought the first part is meant for a general citation of the library. And additionally we have the prefered paper section which should state the library version indepently.

@greole
Copy link
Collaborator Author

greole commented Jun 17, 2024

Looking at the validation guide, especially the title and prefrerred-citation section, I understand it as the current version of the software and the prefrerred-citation is an additional paper which can specify the version separately.

Copy link
Member

@tcojean tcojean left a comment

Choose a reason for hiding this comment

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

Thanks for updating this and checking how it works.

A last problem for me is the authors list in the citation if this is the software citation. In the best case, it should reflect (or directly come from) the contributors.txt file, no? Except if we consider main authors only, whatever that means.

Does anyone have any idea how other packages do it?

CITATION.cff Outdated Show resolved Hide resolved
@greole
Copy link
Collaborator Author

greole commented Jun 17, 2024

There is an example of a mixed authors list with persons and anonymous entries.

authors:
  - given-names: Stephan
    family-names: Druskat
  - name: "The Research Software project"

I guess if we want to distinguish between main named authors and other unnamed authors we could use something like
- name: "The Gingko contributors"

or similar.

Copy link
Member

@yhmtsai yhmtsai left a comment

Choose a reason for hiding this comment

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

Could you also help me to change my first name?

CITATION.cff Outdated Show resolved Hide resolved
Co-authored-by: Terry Cojean <[email protected]>
Co-authored-by: Yu-Hsiang M. Tsai <[email protected]>
@greole greole added the 1:ST:no-changelog-entry Skip the wiki check for changelog update label Jul 2, 2024
@greole greole merged commit 185c5f6 into develop Jul 2, 2024
11 of 14 checks passed
@greole greole deleted the fix/citation_version branch July 2, 2024 12:38
Copy link

sonarcloud bot commented Jul 2, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1:ST:no-changelog-entry Skip the wiki check for changelog update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants