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: polish and format markdown documents #19

Merged
merged 1 commit into from
Dec 12, 2023
Merged

docs: polish and format markdown documents #19

merged 1 commit into from
Dec 12, 2023

Conversation

Peefy
Copy link
Contributor

@Peefy Peefy commented Dec 12, 2023

1. Does this PR affect any open issues?(Y/N) and add issue references (e.g. "fix #123", "re #123".):

  • N
  • Y

docs: polish and format markdown documents

2. What is the scope of this PR (e.g. component or file name):

  • README.md
  • docs/CONTRIBUTING.md
  • docs/CONTRIBUTING_CN.md

3. Provide a description of the PR(e.g. more details, effects, motivations or doc link):

  • Affects user behaviors
  • Contains syntax changes
  • Contains variable changes
  • Contains experimental features
  • Performance regression: Consumes more CPU
  • Performance regression: Consumes more Memory
  • Other

4. Are there any breaking changes?(Y/N) and describe the breaking changes(e.g. more details, motivations or doc link):

  • N
  • Y

5. Are there test cases for these changes?(Y/N) select and add more details, references or doc links:

  • Unit test
  • Integration test
  • Benchmark (add benchmark stats below)
  • Manual test (add detailed scripts or steps below)
  • Other

@Peefy Peefy added the documentation Improvements or additions to documentation label Dec 12, 2023
@Peefy Peefy requested review from amyXia1994 and He1pa December 12, 2023 04:01
Copy link
Contributor

@amyXia1994 amyXia1994 left a comment

Choose a reason for hiding this comment

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

lgtm

@Peefy Peefy merged commit 8887db4 into main Dec 12, 2023
1 check passed
@Peefy Peefy deleted the polish-documents branch December 12, 2023 05:50
@github-actions github-actions bot locked and limited conversation to collaborators Dec 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants