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

Create CITATION.cff #3029

Closed

Conversation

pawelsawicz
Copy link

@pawelsawicz pawelsawicz commented Jul 23, 2023

Description

Hi team

I needed a citation for my MSc Project, and I found that GH supports citation files, so I thought I could create a PR for this so other people could easily get citations for the repo.

I would need your help with the content :)

@gallais
Copy link
Member

gallais commented Jul 23, 2023

The current standard practice AFAIK is to cite https://dblp.org/rec/conf/ecoop/Brady21.html

@pawelsawicz
Copy link
Author

Thanks, I cite that too, and I wanted to cite some specific fragments of code; hence I thought that I could raise a PR

@jfdm
Copy link
Collaborator

jfdm commented Aug 1, 2023

Idris1's citation file was very straightforward and pointed to the journal article.

Looking at the documentation for citation files, however, we can add a preferred citation that then points to the academic journal. Pointing to preferred citations is what other projects do when there is an academic output to cite.

Hopefully the citation.cff can also produce a reference to the software itself.

The only issue is keeping the list of contributors up-to-date for the software citation. Perhaps defaulting to The Idris Community with a note to see the contributors file would be sufficient?

@pawelsawicz
Copy link
Author

Thanks both for your input, this is very helpful. I will make adjustment accordingly

@gallais
Copy link
Member

gallais commented Nov 30, 2023

I suppose we could create zotero entries for the releases.
I am concerned about making the production of releases even more work though
given we've gone more than a year without one, presumably because it's already
too much work.

@gallais gallais closed this Jun 5, 2024
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.

None yet

3 participants