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

Add citation info for ICHEP2022 paper #408

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

graeme-a-stewart
Copy link
Collaborator

@graeme-a-stewart graeme-a-stewart commented Feb 20, 2025

BEGINRELEASENOTES
Add citation information to README.md and corresponding CITATION.cff file
ENDRELEASENOTES

Closes #407

Copy link
Contributor

@m-fila m-fila left a comment

Choose a reason for hiding this comment

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

I'd suggest to go with credit redirection pattern for the citation file:

  • create main citation as for software repository (possibly with help from zenodo export)
  • under field preferred-citation put citation for an article. The "GitHub -> About -> Cite" will point to the article, but more advanced scrappers may use also the extra information about software

@tmadlener
Copy link
Contributor

tmadlener commented Feb 20, 2025

Can we also fit the zenodo information into the CITATIONS.cff somehow, or should we simply also merge #375 to get the batch onto the README?

Citation updated to cite the repository, with the ICHEP paper
as a "preferred-citation".
Criterion for repository author is set at the rather arbitrary +1000 lines bar
@graeme-a-stewart
Copy link
Collaborator Author

graeme-a-stewart commented Feb 21, 2025

Thanks @m-fila - that's a good suggestion about the preferred-citation. I updated that. I also added the Zenodo DOI badge, originally from #375.

With respect of credit to the code authors, I checked https://github.com/key4hep/EDM4hep/graphs/contributors and decided to cut on >=1000 lines contributed. To be discussed...

Tangentially, https://allcontributors.org is a great way of acknowledging the contributions of the whole community to the project (see, e.g., https://github.com/JuliaHEP/JetReconstruction.jl?tab=readme-ov-file#contributors-)

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 citation / CITATION.cff
3 participants