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 ampycloud citation details #135

Merged
merged 2 commits into from
Aug 28, 2024
Merged

Update ampycloud citation details #135

merged 2 commits into from
Aug 28, 2024

Conversation

fpavogt
Copy link
Member

@fpavogt fpavogt commented Aug 27, 2024

Description:

Basic PR to update the citation info for the code, following the publication of the associated journal article.

Error(s) fixed:

Checklists:

  • New code includes dedicated tests.
  • New code has been linted.
  • New code follows the project's style.
  • New code is compatible with the 3-Clause BSD license.
  • CHANGELOG has been updated.
  • AUTHORS has been updated.
  • Copyright years in module docstrings have been updated.

@fpavogt fpavogt added this to the v2.0.0 milestone Aug 27, 2024
@fpavogt fpavogt requested a review from regDaniel August 27, 2024 11:20
@fpavogt fpavogt self-assigned this Aug 27, 2024
@fpavogt
Copy link
Member Author

fpavogt commented Aug 27, 2024

@regDaniel : fyi, this is my first time toying around with the CITATIONS.cff file ... I've done the best I could, but we should definitely make sure that the final result (when the PR is merged) looks good (and correct).

@regDaniel
Copy link
Collaborator

Thanks @fpavogt tbh, I'm slightly overwhelmed with how to review this.. 😄 Not sure if you were suggesting the same yesterday but my suggestion would be to create a release 2.1.0 (along with a PR that I'm going to open in the afternoon) and then check if the citation appears correctly on Zenodo. Ok?
Also, I will open an MR in the afternoon with a new feature and - more importantly here - a fix for the build pipeline. Maybe we can coordinate the merging such that the build pipeline is fixed before we merge this one here.

@fpavogt
Copy link
Member Author

fpavogt commented Aug 28, 2024

@regDaniel: I would not worry (too much) about the impact on Zenodo. The main impact of the CITATION file will be on the main page of the repo (right-hand side) where the info will be clearly and easily usable. There's certainly no rush to merge this PR ... but at the same time, there's also no need to wait for a new release. A simple merge will already tell us if the outcome is as we expect it to be (on the main repo page).

@regDaniel
Copy link
Collaborator

Then I would suggest to merge even though the pipeline fails so we can see the outcome. There is almost no risk of side effects for this MR.

@fpavogt fpavogt merged commit 1fc7a14 into develop Aug 28, 2024
5 of 14 checks passed
@fpavogt fpavogt deleted the cite branch August 28, 2024 15:06
@regDaniel regDaniel mentioned this pull request Sep 4, 2024
2 tasks
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