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

Update citation documentation and metadata #721

Merged
merged 7 commits into from
Aug 14, 2023

Conversation

MattF-NSIDC
Copy link

@MattF-NSIDC MattF-NSIDC commented Aug 10, 2023

Description

Resolves #702

CITATION.cff is now more fully populated. We needed the ability to auto-update the date-released field, and that led to switching from bump2version (unmaintained) to bump-my-version (another fork, modernized and maintained). Very pleasant experience there.

I attempted to start a new DOI for QGreenland the dataset. I found that if I do this, nobody else will be able to edit it or add new versions until Zenodo does a major platform upgrade expected in September this year. I feel it's important that @twilamoon-science set this up so she's able to own the record long-term.

Checklist

If an item on this list is done or not needed, check it with [x] or click the
checkbox.

  • The PR description links to issues that it resolves with closes #{issue_number}
  • Config lockfile updated (inv config.export > qgreenland/config/cfg-lock.json)
  • Environment lockfile updated if needed (conda-lock)
  • Version bumped if needed (bumpversion (major|minor|patch|prerelease|build))
  • CHANGELOG.md updated
  • Documentation updated if needed
  • New unit tests if needed

@MattF-NSIDC MattF-NSIDC changed the title WIP update citation documentation and metadata WIP - update citation documentation and metadata Aug 10, 2023
@MattF-NSIDC
Copy link
Author

Next steps: Create a dataset DOI for QGreenland and upload to Zenodo

@MattF-NSIDC MattF-NSIDC marked this pull request as ready for review August 14, 2023 21:50
given-names: "Twila"
orcid: "https://orcid.org/0000-0003-0968-7008"
- family-names: "Fisher"
- family-names: "*Fisher"
Copy link
Author

Choose a reason for hiding this comment

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

Putting the asterisk in the family-names attribute seems to work well in the citations generated by GitHub. Hopefully Zenodo will also be OK with it and the work will be correctly link to our orcids.

orcid: "https://orcid.org/0000-0003-0968-7008"
- family-names: "Thurber"
given-names: "Alyse"
orcid: "https://orcid.org/0009-0003-2026-0002"
Copy link
Author

Choose a reason for hiding this comment

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

@twilamoon-science @alysethurber I added Trey and my own GitHub profiles to our author entries with the website key. Do you guys have website you'd like to link here?


Please choose the appropriate citation depending on which you use.

An asterisk (`*`) indicates co-equal lead authorship (listed alphabetically).
Copy link
Author

Choose a reason for hiding this comment

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

Should we do listed randomly instead? What's the best practice here?

@@ -64,7 +64,6 @@ dependencies:

# other utilities
- conda-lock
- bump2version
Copy link
Author

Choose a reason for hiding this comment

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

Deja vu!

Copy link
Contributor

Choose a reason for hiding this comment

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

🙃

pyproject.toml Outdated
Copy link
Author

@MattF-NSIDC MattF-NSIDC Aug 14, 2023

Choose a reason for hiding this comment

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

INI config works but is deprecated with bump-my-version, figured might as well migrate.

Copy link
Contributor

@trey-stafford trey-stafford left a comment

Choose a reason for hiding this comment

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

Looks good! One comment that might need addressed and then just a couple of suggestions.

CITATION.cff Outdated Show resolved Hide resolved
CITATION.cff Show resolved Hide resolved
@@ -64,7 +64,6 @@ dependencies:

# other utilities
- conda-lock
- bump2version
Copy link
Contributor

Choose a reason for hiding this comment

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

🙃

environments/main/environment.yml Outdated Show resolved Hide resolved
mfisher87 and others added 3 commits August 14, 2023 16:18
Co-authored-by: Trey Stafford <trey.stafford@colorado.edu>
Co-authored-by: Trey Stafford <trey.stafford@colorado.edu>
@MattF-NSIDC MattF-NSIDC changed the title WIP - update citation documentation and metadata Update citation documentation and metadata Aug 14, 2023
@MattF-NSIDC MattF-NSIDC merged commit 89e6985 into main Aug 14, 2023
2 checks passed
@MattF-NSIDC MattF-NSIDC deleted the citations-and-authorship branch August 14, 2023 22:45
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.

Distinguish code/software and data citations and update authorship
3 participants