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 README #316

Merged
merged 6 commits into from
Apr 15, 2024
Merged

docs: update README #316

merged 6 commits into from
Apr 15, 2024

Conversation

Gaiejj
Copy link
Member

@Gaiejj Gaiejj commented Apr 10, 2024

Description

  • Update publications using OmniSafe in README page.
  • Update contents on the tutorials page.
  • Polish typos in tutorials.

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds core functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)

Checklist

Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

  • I have read the CONTRIBUTION guide. (required)
  • My change requires a change to the documentation.
  • I have updated the tests accordingly. (required for a bug fix or a new feature)
  • I have updated the documentation accordingly.
  • I have reformatted the code using make format. (required)
  • I have checked the code using make lint. (required)
  • I have ensured make test pass. (required)

@Gaiejj Gaiejj added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 10, 2024
Copy link

codecov bot commented Apr 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.56%. Comparing base (63bdd34) to head (e33cc1f).

Additional details and impacted files
@@            Coverage Diff            @@
##           main     #316       +/-   ##
=========================================
+ Coverage      0   96.56%   +96.56%     
=========================================
  Files         0      139      +139     
  Lines         0     7090     +7090     
=========================================
+ Hits          0     6846     +6846     
- Misses        0      244      +244     

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

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
tutorials/README.md Outdated Show resolved Hide resolved
tutorials/README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
tutorials/README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@muchvo muchvo left a comment

Choose a reason for hiding this comment

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

LGTM.

@Gaiejj Gaiejj merged commit c6c8aa9 into PKU-Alignment:main Apr 15, 2024
4 checks passed
@Gaiejj Gaiejj deleted the dev-readme branch April 15, 2024 03:47
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants