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

Update CITATION.cff to use preferred-citation #157

Merged
merged 8 commits into from
Jul 10, 2023

Conversation

BenjaminRodenberg
Copy link
Member

@BenjaminRodenberg BenjaminRodenberg commented Jun 30, 2023

  • Use preferred-citation to point to the FEniCS-preCICE paper
  • Provide citation information about software on top level.
    • Open for discussion: Might be extended with other/future contributors that did not author the paper. Important: We need a proper and simple policy here. See also https://github.com/precice/fenics-adapter/graphs/contributors
    • Add a DOI? We could point to the preCICE distribution, but this is actually a superset of FEniCS-preCICE and the policy w.r.t. authorship is also independent. I would rather keep things separate and not provide a DOI. If we really want a DOI, we can still release on zenodo. This looks to me like the go-to-solution suggested by the CFF developers: https://citation-file-format.github.io/

@BenjaminRodenberg
Copy link
Member Author

@richahert

Copy link
Collaborator

@ajaust ajaust 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 the citation information.

Should the discussion about the DOI and future authors be in separate issues?

When going through the repository I found another point that should potentially be discussed: Where/How do we want to maintain the citation information of the FEniCS adapter.

Currently, we have to maintain three places:

  1. This CITATION.cff file.

    The file and citation mechanism might be new to many people so we might need to explicitly mention GitHub's citation mechanism somewhere.

  2. There is a citation section in the README.

  3. There is a section on the adapter website that is part of the project.

@BenjaminRodenberg BenjaminRodenberg merged commit 0a8f031 into develop Jul 10, 2023
@BenjaminRodenberg BenjaminRodenberg deleted the update-citation-cff branch July 10, 2023 08:08
BenjaminRodenberg added a commit that referenced this pull request Sep 28, 2023
Link is again broken. Decided to remove it after just fixing it via #157
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants