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 in preparation for version 1 release #289

Merged
merged 6 commits into from
Jun 11, 2023

Conversation

gwaybio
Copy link
Member

@gwaybio gwaybio commented Jun 8, 2023

Description

Reorganizing, rewording, and adding to README in preparation for version 1 release.

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.

@gwaybio
Copy link
Member Author

gwaybio commented Jun 8, 2023

Merging this PR will close #277

@gwaybio gwaybio requested a review from d33bs June 8, 2023 23:30
@codecov-commenter
Copy link

codecov-commenter commented Jun 8, 2023

Codecov Report

Merging #289 (2b8df8b) into master (77d93a3) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #289   +/-   ##
=======================================
  Coverage   95.12%   95.12%           
=======================================
  Files          57       57           
  Lines        3057     3057           
=======================================
  Hits         2908     2908           
  Misses        149      149           
Flag Coverage Δ
unittests 95.12% <ø> (ø)

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

@gwaybio gwaybio mentioned this pull request Jun 10, 2023
13 tasks
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.

I'd recommend a few changes in the alternative installation instructions:

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
gwaybio and others added 3 commits June 11, 2023 12:59
Co-authored-by: Ken Brewer <kenibrewer@users.noreply.github.com>
@gwaybio
Copy link
Member Author

gwaybio commented Jun 11, 2023

Thanks for the review @kenibrewer !

Are you able to approve the PR? It seems you went through thoroughly, so I am happy to merge after having your eyes on it.

@kenibrewer
Copy link
Member

@gwaybio I approved the changes, but I don't count as a reviewer with write access. I assume you can probably merge anyways though.

@gwaybio gwaybio merged commit 921dcfe into cytomining:master Jun 11, 2023
@gwaybio gwaybio deleted the update-readme branch June 11, 2023 20:55
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.

3 participants