Skip to content

chore(readme): Optimize the text description in README#44

Merged
keli-wen merged 3 commits intomasterfrom
pkudba-patch-3
Jul 29, 2025
Merged

chore(readme): Optimize the text description in README#44
keli-wen merged 3 commits intomasterfrom
pkudba-patch-3

Conversation

@pkudba
Copy link
Copy Markdown
Collaborator

@pkudba pkudba commented Jul 28, 2025

Description

Checklist

Please feel free to remove inapplicable items for your PR.

  • The PR title starts with [$CATEGORY] (such as [Docs], [Fix], [Feature], [Refactor])
  • Related issue is referred in this PR
  • The markdown and latex are rendered correctly.
  • The code in PR is well-documented.
  • The PR is complete and small, read the Google eng practice (CL equals to PR) to understand more about small PR.

@keli-wen
Copy link
Copy Markdown
Contributor

it seems fail with the following message:

trim trailing whitespace.................................................Failed
- hook id: trailing-whitespace
- exit code: 1
- files were modified by this hook

I recommend @pkudba to execute the following commands:

pip install pre-commit
pre-commit install
pre-commit run --all-files

to automatically format the markdown file in local env.

@keli-wen keli-wen added the documentation Improvements or additions to documentation label Jul 28, 2025
Comment thread README.md
@keli-wen
Copy link
Copy Markdown
Contributor

After polish and pass the pre-check, you can re-request my review. After the approval, we can merge the change into our master branch.

@pkudba
Copy link
Copy Markdown
Collaborator Author

pkudba commented Jul 28, 2025

All pre-checks have already been passed.

@keli-wen keli-wen self-requested a review July 29, 2025 11:39
Copy link
Copy Markdown
Contributor

@keli-wen keli-wen left a comment

Choose a reason for hiding this comment

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

LGTM

@keli-wen keli-wen merged commit e37fbb4 into master Jul 29, 2025
2 checks passed
@keli-wen keli-wen deleted the pkudba-patch-3 branch July 29, 2025 11:39
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.

2 participants