capa icon indicating copy to clipboard operation
capa copied to clipboard

Add citations file

Open williballenthin opened this issue 1 year ago • 8 comments

to make research papers easier, etc.

williballenthin avatar Jan 13 '24 18:01 williballenthin

I can do this! Would I just need to add a CITATION.cff file to the repository?

JCoonradt avatar Jan 26 '24 20:01 JCoonradt

Yes, I'd follow this documentation https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files

mr-tz avatar Jan 26 '24 21:01 mr-tz

Great, thank you that is very helpful! Who should I put down as the authors, as this is an open-source program? Also, do we have those authors' Orcid IDs? I think the Orcid ID part is optional, so I just need the authors' names.

JCoonradt avatar Jan 26 '24 21:01 JCoonradt

I suggest:

  • name: "The FLARE Team"

Or we could list the core team by name?

Reference: https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md#definitionsreferenceauthors

mr-tz avatar Jan 29 '24 09:01 mr-tz

Thanks for the help! I will add the citation file under the name "The Flare Team" tonight!

JCoonradt avatar Jan 31 '24 17:01 JCoonradt

hi has a CITATION.cff been added by @JCoonradt , otherwise i would love working on this right away ,please do let me know

Atlas-64 avatar Feb 29 '24 06:02 Atlas-64

@mr-tz where can I find the the relevant info for the core team or would just "The FLARE Team" suffice for the citation

Atlas-64 avatar Feb 29 '24 14:02 Atlas-64

@mr-tz @williballenthin have made a PR update with a CITATION.cff please review and comment on any changes if possible.

Atlas-64 avatar Feb 29 '24 16:02 Atlas-64

closed via #2018

mr-tz avatar May 22 '24 08:05 mr-tz