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 Readme with Citation section #359

Merged
merged 9 commits into from
Dec 4, 2023
Merged

Conversation

axiomcura
Copy link
Member

modified from EmbeddedArtistry

Description

Thank you for your contribution to pycytominer!
Please succinctly summarize your proposed change.
What motivated you to make this change?

This pull request introduces a section in the README titled Citing pycytominer. The changes made here will also reflect on the Read the Docs webpage, here is a preview, providing information on how to cite the pycytominer package.

Please also link to any relevant issues that your code is associated with.

What is the nature of your change?

  • Bug fix (fixes an issue).
  • Enhancement (adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • This change requires a documentation update.

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 commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • New and existing unit tests pass locally with my changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have deleted all non-relevant text in this pull request template.

@axiomcura axiomcura changed the title updated readme with preprint Update Readme with Citation section Nov 30, 2023
@codecov-commenter
Copy link

codecov-commenter commented Nov 30, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (98d7ffa) 95.57% compared to head (c15c7a5) 95.57%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #359   +/-   ##
=======================================
  Coverage   95.57%   95.57%           
=======================================
  Files          56       56           
  Lines        3138     3138           
=======================================
  Hits         2999     2999           
  Misses        139      139           
Flag Coverage Δ
unittests 95.57% <ø> (ø)

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

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

@axiomcura axiomcura requested a review from d33bs November 30, 2023 01:10
Copy link
Member

@kenibrewer kenibrewer left a comment

Choose a reason for hiding this comment

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

@axiomcura This new citation should be updated in the CITATION.cff file as well.

@axiomcura
Copy link
Member Author

Thanks @kenibrewer! I have updated the CITATION.cff file with updated author list and also added the DOI and updated the title!

@axiomcura axiomcura requested a review from kenibrewer November 30, 2023 17:03
CITATION.cff Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
CITATION.cff Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
axiomcura and others added 3 commits December 2, 2023 17:47
Co-authored-by: Gregory Way <gregory.way@gmail.com>
README.md Outdated Show resolved Hide resolved
@axiomcura
Copy link
Member Author

@d33bs @gwaybio @kenibrewer Hello! I have attended to all your comments and suggestions!

README.md Outdated Show resolved Hide resolved
Copy link
Member

@kenibrewer kenibrewer left a comment

Choose a reason for hiding this comment

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

A few more minor fixes, but otherwise things LGTM

axiomcura and others added 2 commits December 4, 2023 10:28
Co-authored-by: Ken Brewer <kenibrewer@users.noreply.github.com>
Co-authored-by: Ken Brewer <kenibrewer@users.noreply.github.com>
Copy link
Member

@gwaybio gwaybio left a comment

Choose a reason for hiding this comment

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

Thanks Erik! I'll merge now :)

@gwaybio gwaybio merged commit a671c3b into cytomining:main Dec 4, 2023
9 checks passed
@axiomcura axiomcura deleted the add-citation branch December 4, 2023 20:16
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.

5 participants