Skip to content

DOC: Add README.md #24

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

Merged
merged 5 commits into from
Jun 6, 2023
Merged

DOC: Add README.md #24

merged 5 commits into from
Jun 6, 2023

Conversation

aresnow1
Copy link
Contributor

@aresnow1 aresnow1 commented Jun 6, 2023

What do these changes do?

Add README.md.

Related issue number

Fixes #xxxx

Check code requirements

  • tests added / passed (if needed)
  • Ensure all linting tests pass

@XprobeBot XprobeBot added this to the v0.0.6 milestone Jun 6, 2023
@codecov
Copy link

codecov bot commented Jun 6, 2023

Codecov Report

Merging #24 (d3f4da9) into main (d4ace47) will decrease coverage by 0.66%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main      #24      +/-   ##
==========================================
- Coverage   91.30%   90.64%   -0.66%     
==========================================
  Files          42       42              
  Lines        3187     3187              
  Branches      638      638              
==========================================
- Hits         2910     2889      -21     
- Misses        204      218      +14     
- Partials       73       80       +7     
Flag Coverage Δ
unittests 90.55% <ø> (-0.60%) ⬇️

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

see 5 files with indirect coverage changes

@UranusSeven UranusSeven changed the title Add README.md DOC: Add README.md Jun 6, 2023
@XprobeBot XprobeBot added the documentation Improvements or additions to documentation label Jun 6, 2023
Hank0626
Hank0626 previously approved these changes Jun 6, 2023
qianduoduo0904
qianduoduo0904 previously approved these changes Jun 6, 2023
Copy link
Contributor

@qianduoduo0904 qianduoduo0904 left a comment

Choose a reason for hiding this comment

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

LGTM

Co-authored-by: UranusSeven <109661872+UranusSeven@users.noreply.github.com>
Co-authored-by: UranusSeven <109661872+UranusSeven@users.noreply.github.com>
Copy link
Contributor

@UranusSeven UranusSeven left a comment

Choose a reason for hiding this comment

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

LGTM.

Copy link
Contributor

@UranusSeven UranusSeven left a comment

Choose a reason for hiding this comment

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

LGTM.

@aresnow1 aresnow1 requested a review from qianduoduo0904 June 6, 2023 10:06
Copy link
Contributor

@qianduoduo0904 qianduoduo0904 left a comment

Choose a reason for hiding this comment

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

LGTM

@mergify mergify bot merged commit fb7d32c into xorbitsai:main Jun 6, 2023
UranusSeven added a commit to UranusSeven/xoscar that referenced this pull request Jun 6, 2023
* Add readme

* Fix

* Fix

* Update README.md

Co-authored-by: UranusSeven <109661872+UranusSeven@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: UranusSeven <109661872+UranusSeven@users.noreply.github.com>

---------

Co-authored-by: UranusSeven <109661872+UranusSeven@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants