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

Filling in metadata #23

Merged
merged 10 commits into from
Aug 13, 2024
Merged

Filling in metadata #23

merged 10 commits into from
Aug 13, 2024

Conversation

richardreeve
Copy link
Member

No description provided.

Copy link

codecov bot commented Jul 21, 2024

Codecov Report

Attention: Patch coverage is 14.63415% with 35 lines in your changes missing coverage. Please review.

Project coverage is 20.86%. Comparing base (481226c) to head (a30cfd9).

Files Patch % Lines
src/Interface.jl 15.62% 27 Missing ⚠️
src/PlotRecipes.jl 0.00% 8 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #23      +/-   ##
==========================================
+ Coverage   20.16%   20.86%   +0.70%     
==========================================
  Files           2        3       +1     
  Lines         124      139      +15     
==========================================
+ Hits           25       29       +4     
- Misses         99      110      +11     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@@ -1,21 +1,9 @@
MIT License

Copyright (c) 2018-2021: Michael K. Borregaard, Richard Reeve and EcoJulia
Copyright (c) 2018-2024 Michael Borregaard, Richard Reeve and Kevin Bonham
Copy link
Member

Choose a reason for hiding this comment

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

I'm certainly not opposed to this, but also don't know if I've made substantial contribution to the code to warrant inclusion here.

Copy link
Member Author

@richardreeve richardreeve Jul 22, 2024

Choose a reason for hiding this comment

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

Thanks @kescobo. I'm forcing the metadata to be consistent across different formats (Project.toml, codemeta.json, .zenodo.json, LICENSE) by developing a metadata package ResearchSoftwareMetadata which does a crosswalk between the formats. You're an author in Project.toml (and I'm totally happy with that), so you're an author in every metadata format, which is why you now appear everywhere else.

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
Copy link
Member

Choose a reason for hiding this comment

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

I prefer keeping the line breaks myself - better if they were sembr, but 🤷

Copy link
Member Author

Choose a reason for hiding this comment

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

The license is now taken from SPDX given whatever you put into the license field in Project.toml. Unfortunately there are no line breaks in the text from there... I'm happy either way tbh, but that's the official text.

"identifier": "https://ror.org/035b05819"
}
]
}
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
}
},
{
"type": "Person",
"givenName": "Kevin",
"familyName": "Bonham",
"id": "https://orcid.org/0000-0003-3200-7533",
"affiliation": [
{
"type": "Organization",
"name": "Wellesley College",
"identifier": "https://ror.org/01srpnj69"
}
]
}

Only if you want to include me above (which again, I would not insist on)

Also, there's a non-trivial chance that my affiliation is going to change in the next few months, but I can update as necessary if that happens.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks - I've added that in. But the only place you need to change anything in is the ror in Project.toml, and then rerun the crosswalk, which you can do by running ResearchSoftwareMetadata.crosswalk() and it will update everywhere else.

@richardreeve
Copy link
Member Author

Thanks for the feedback @kescobo - if you're interested in where these changes come from, you may want to look at the ResearchSoftwareMetadata package, which I'm currently working on. I'm also using JuliaFormatter to clean up the code formatting. Comments welcome there too!

@richardreeve richardreeve merged commit 7c4ed6a into main Aug 13, 2024
11 of 12 checks passed
@richardreeve richardreeve deleted the rr/metadata branch August 13, 2024 22:40
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.

2 participants