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: readme update #28

Merged
merged 11 commits into from
Jul 11, 2023
Merged

docs: readme update #28

merged 11 commits into from
Jul 11, 2023

Conversation

drwnz
Copy link
Collaborator

@drwnz drwnz commented Jun 14, 2023

PR Type

  • Improvement

Related Links

TIER IV INTERNAL LINK

Description

Updates README to be consistent with current driver implementation.

Review Procedure

Remarks

Pre-Review Checklist for the PR Author

PR Author should check the checkboxes below when creating the PR.

  • Assign PR to reviewer

Checklist for the PR Reviewer

Reviewers should check the checkboxes below before approval.

  • Commits are properly organized and messages are according to the guideline
  • (Optional) Unit tests have been written for new behavior
  • PR title describes the changes

Post-Review Checklist for the PR Author

PR Author should check the checkboxes below before merging.

  • All open points are addressed and tracked via issues or tickets

CI Checks

  • Build and test for PR: Required to pass before the merge.

@drwnz drwnz requested review from amc-nu and aohsato June 14, 2023 09:09
Copy link
Collaborator

@aohsato aohsato left a comment

Choose a reason for hiding this comment

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

Great work, I added some review comments.

@drwnz drwnz changed the title Docs/readme update docs: readme update Jul 7, 2023
@codecov-commenter
Copy link

codecov-commenter commented Jul 10, 2023

Codecov Report

❗ No coverage uploaded for pull request base (main@454e7bf). Click here to learn what that means.
Patch has no changes to coverable lines.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #28   +/-   ##
=======================================
  Coverage        ?   11.29%           
=======================================
  Files           ?       33           
  Lines           ?     4604           
  Branches        ?     1145           
=======================================
  Hits            ?      520           
  Misses          ?     3141           
  Partials        ?      943           
Flag Coverage Δ
differential 11.29% <0.00%> (?)

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

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@drwnz drwnz force-pushed the docs/readme_update branch from e474436 to 92f7dc5 Compare July 10, 2023 04:16
@drwnz drwnz requested a review from aohsato July 10, 2023 04:23
@drwnz drwnz merged commit a3d2788 into main Jul 11, 2023
@drwnz drwnz mentioned this pull request Jul 11, 2023
5 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.

5 participants