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

docs: update CITATION.cff and pyproject.toml authors #339

Merged
merged 1 commit into from
Oct 28, 2023

Conversation

kenibrewer
Copy link
Member

@kenibrewer kenibrewer commented Oct 27, 2023

Description

This change updates the author list contained in the CITATION.cff for the pycytominer publication. It also updates the authors and maintainer list in the pyproject.toml.

Closes #316

What is the nature of your change?

  • Bug fix (fixes an issue).

Checklist

Please ensure that all boxes are checked before indicating that a pull request is ready for review.

  • I have read the CONTRIBUTING.md guidelines.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have deleted all non-relevant text in this pull request template.

@codecov-commenter
Copy link

codecov-commenter commented Oct 27, 2023

Codecov Report

Merging #339 (02d17d4) into main (afe5df3) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #339   +/-   ##
=======================================
  Coverage   95.40%   95.40%           
=======================================
  Files          56       56           
  Lines        3134     3134           
=======================================
  Hits         2990     2990           
  Misses        144      144           
Flag Coverage Δ
unittests 95.40% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@kenibrewer
Copy link
Member Author

@gwaybio I haven't updated the authors list in the pyproject.toml yet. There are a few questions I'd like some guidance on because I'm not sure if the norms for pyproject.toml authors differs from academic publications. I can't find any online guidance online, so I presume we can do whatever we want here.

  1. Do we include the full list of authors from the CITATION.cff or only a subset?
  2. Do we include email address for all the authors listed or only a subset (e.g. maintainers and corresponding authors)?
  3. Do we use the same ordering of authors here as for the publication or some alternate order?

In case you want to suggest changes for that author list yourself, I'll email you a txt file with the properly formatted author list with everyone's emails. I just wanted to be careful to not add any email address to a repo unless they will be staying there. I'm also happy to take care of it, if you'd like to just respond to the questions.

@kenibrewer kenibrewer marked this pull request as ready for review October 27, 2023 14:42
@gwaybio
Copy link
Member

gwaybio commented Oct 27, 2023

Thanks @kenibrewer - this PR is perfect timing.

Responses

Do we include the full list of authors from the CITATION.cff or only a subset?

Let's include all. After the paper is published it will become the default citation. Do you know what happens with the CITATION.cff file after? Maybe it just points to the paper DOI?

Do we include email address for all the authors listed or only a subset (e.g. maintainers and corresponding authors)?

I think we should avoid adding any additional contact details. We want to encourage public engagement (via issues/PRs/etc.) and we have a CONTRIBUTING.md that specifies a contact for sensitive matters.

Do we use the same ordering of authors here as for the publication or some alternate order?

Let's keep things simple and maintain the same order.

Additional question

I'm also wondering how a poetry-style repo should handle the __about__.py file. Do you have any recommendations?

I want to avoid the situation of needing to bump versions in multiple spots manually.

@kenibrewer
Copy link
Member Author

@gwaybio This is ready for review.

I'm also wondering how a poetry-style repo should handle the about.py file. Do you have any recommendations?

I actually already have this feature already implemented in a different PR that dave is reviewing. 😊

@kenibrewer kenibrewer merged commit 871b633 into cytomining:main Oct 28, 2023
10 checks passed
@kenibrewer kenibrewer deleted the docs/update-authors branch October 28, 2023 12:41
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.

Update CITATION.cff and pyproject.toml with updated author/maintainer list.
3 participants