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 COI and CRediT info to contribution metadata template format #18

Closed
mprobson opened this issue Mar 23, 2020 · 2 comments · Fixed by #48
Closed

Add COI and CRediT info to contribution metadata template format #18

mprobson opened this issue Mar 23, 2020 · 2 comments · Fixed by #48
Labels
Technical Technical concerns, enhancements, etc. for the GitHub enthusiasts

Comments

@mprobson
Copy link
Collaborator

This repo requires conflict of interest disclosure (COI) to be added to the metadata file for a new author entry but the template format is not specified in the linked file.

Additionally, the contribution section does not make note of the fact that it should be one of the fourteen CredIT taxonomy roles found here: https://casrai.org/credit/

Possible solutions include pointing the template format at something other than the rootstock default since this is repo specific or including extra directions and links in the main README.md file. Alternatively, a CONTRIBUTING.md file could describe this process in greater detail (and be linked to from the main page). More info on CONTRIBUTING files and there use in software projects on GitHub can be found here: https://help.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors . I would be happy to help author any/all of these documents or changes.

Thanks again for putting this all together and welcoming so many people!

@cgreene
Copy link
Member

cgreene commented Mar 23, 2020

I agree that adding this information in our USAGE.md document and directly linking to how to add oneself as an author as part of the first pull request with content would be great to have in the README.md file.

I think that you can propose a PR here that will include this information:
https://github.com/greenelab/covid19-review/blob/master/USAGE.md#manuscript-metadata

I wanted to get the COI because it may be pertinent for some contributors and it'll make things more straightforward when this gets submitted to a journal. For a past review we had to go back to everyone for the information. We may still need to do that, but now they'll just have to update the dates. Thanks!

@cgreene
Copy link
Member

cgreene commented Mar 23, 2020

Oh, and the CRediT taxonomy mention would be great too! I've not used it before and it doesn't look perfect for a review, but it'll be helpful to have folks contribution types captured when we have to make author ordering decisions.

@rando2 rando2 added the Technical Technical concerns, enhancements, etc. for the GitHub enthusiasts label Mar 24, 2020
rando2 pushed a commit to rando2/covid19-review that referenced this issue Mar 25, 2020
@rando2 rando2 linked a pull request Mar 25, 2020 that will close this issue
rando2 pushed a commit that referenced this issue Mar 25, 2020
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Technical Technical concerns, enhancements, etc. for the GitHub enthusiasts
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants