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 readme documents #1046

Merged
merged 1 commit into from
Feb 18, 2024
Merged

docs: polish readme documents #1046

merged 1 commit into from
Feb 18, 2024

Conversation

Peefy
Copy link
Contributor

@Peefy Peefy commented Feb 18, 2024

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

  • N
  • Y

docs: polish readme documents

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

  • README-zh.md
  • README.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

Signed-off-by: peefy <xpf6677@163.com>
@Peefy Peefy added the docs label Feb 18, 2024
@coveralls
Copy link
Collaborator

Pull Request Test Coverage Report for Build 7946293384

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 72.298%

Totals Coverage Status
Change from base Build 7946135307: 0.0%
Covered Lines: 43880
Relevant Lines: 60693

💛 - Coveralls

@Peefy Peefy merged commit c421ce1 into kcl-lang:main Feb 18, 2024
7 of 8 checks passed
@Peefy Peefy deleted the polish-readme-doc branch February 18, 2024 03:39
@github-actions github-actions bot locked and limited conversation to collaborators Feb 18, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants