Skip to content

first draft of citation file#790

Merged
pshriwise merged 7 commits into
svalinn:developfrom
shimwell:adding_citation_file
Feb 15, 2022
Merged

first draft of citation file#790
pshriwise merged 7 commits into
svalinn:developfrom
shimwell:adding_citation_file

Conversation

@shimwell

Copy link
Copy Markdown
Member

Description

Following on from discussion with @kkiesling in the Slack channel here is a draft citation file.

I have been through the contributors section and added details for each github username that has contributed. This is difficult for a few user accounts that don't have first or last names in their profile. Perhaps these users can be tagged using @ if this PR goes ahead.
ORCID are also difficult to find for everyone so perhaps the contributors with missing ORCID can also be tagged and asked for their ORCID.

Currently the list is sorted by commits as that was easy to get from the contributors page, but could be changed to any order that is preferred?
Also a paper could be added if that is preferred?

Further details

Motivation and Context

Helps users easily cite the software using the standard GitHub CITATION file which produces a bibtex and other formats citation link on the right hand side of the repository. See here for more details https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files

Changes

documentation update

Behavior

Citation of the software is perhaps less frequent and harder than it needs to be

@kkiesling

Copy link
Copy Markdown
Contributor

This has prompted me to find my ORCID that I made a long time ago and haven't ever used.. https://orcid.org/0000-0002-1215-2541

Comment thread CITATION.cff
@pshriwise

pshriwise commented Nov 17, 2021

Copy link
Copy Markdown
Member

@iulian787 and @vijaysm are almost certainly Iulian Grindeanu (https://orcid.org/0000-0002-0264-8236) and Vijay S. Mahadevan (https://orcid.org/0000-0002-3337-2607) from ANL.

It looks like @SudoVim is from pullrequest.com?

@SudoVim

SudoVim commented Nov 17, 2021

Copy link
Copy Markdown
Contributor

It looks like @SudoVim is from pullrequest.com?

Yeah, I'm from pullrequest.com. Do you still need my last name? At any rate, I updated my profile with my company and name.

@shimwell

Copy link
Copy Markdown
Member Author

It looks like @SudoVim is from pullrequest.com?

Yeah, I'm from pullrequest.com. Do you still need my last name? At any rate, I updated my profile with my company and name.

Super, thanks. I shall add your names as it is on the profile

Comment thread CITATION.cff Outdated
Comment thread CITATION.cff Outdated
@shimwell

Copy link
Copy Markdown
Member Author

I think we have nearly everyone who has contributed apart

Just missing the name for @dqwu

@pshriwise pshriwise left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This has been sitting here for a while. It looks like a good addition to me. Thanks @shimwell!

@pshriwise pshriwise merged commit 4208614 into svalinn:develop Feb 15, 2022
@shimwell shimwell deleted the adding_citation_file branch February 15, 2022 16:29
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.

4 participants