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: refine KCLVM readme #182

Merged
merged 1 commit into from
Sep 8, 2022
Merged

docs: refine KCLVM readme #182

merged 1 commit into from
Sep 8, 2022

Conversation

Peefy
Copy link
Contributor

@Peefy Peefy commented Sep 5, 2022

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

  • N
  • Y

re #165. Refine KCL readme badges and documents.

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

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

6. Release note

Please refer to Release Notes Language Style Guide to write a quality release note.

None

@Peefy Peefy added the docs label Sep 5, 2022
@Peefy Peefy added this to the v0.4.4 Release milestone Sep 5, 2022
@Peefy Peefy self-assigned this Sep 5, 2022
@coveralls
Copy link
Collaborator

coveralls commented Sep 5, 2022

Pull Request Test Coverage Report for Build 3013827738

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 2 unchanged lines in 1 file lost coverage.
  • Overall coverage decreased (-0.005%) to 60.418%

Files with Coverage Reduction New Missed Lines %
kclvm/compiler/src/codegen/llvm/context.rs 2 74.15%
Totals Coverage Status
Change from base Build 3013501420: -0.005%
Covered Lines: 23789
Relevant Lines: 39374

💛 - Coveralls

@Peefy Peefy changed the title [WIP] docs: update badges and TOC in readme. docs: refine KCLVM readme Sep 5, 2022
@Peefy Peefy force-pushed the doc_update_readme branch 3 times, most recently from 1b683bf to 9918e0c Compare September 5, 2022 14:37
@ldxdl
Copy link
Contributor

ldxdl commented Sep 6, 2022

LGTM

ldxdl
ldxdl previously approved these changes Sep 6, 2022
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
chai2010
chai2010 previously approved these changes Sep 7, 2022
Copy link
Contributor

@chai2010 chai2010 left a comment

Choose a reason for hiding this comment

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

LGTM

He1pa
He1pa previously approved these changes Sep 7, 2022
Copy link
Contributor

@He1pa He1pa 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 dismissed stale reviews from He1pa and chai2010 via 52556d3 September 7, 2022 07:26
@Peefy Peefy dismissed stale reviews from He1pa and zong-zhe via d239ce3 September 7, 2022 08:06
@Peefy Peefy force-pushed the doc_update_readme branch 2 times, most recently from 4a3c897 to ca89991 Compare September 7, 2022 08:27
@zong-zhe zong-zhe self-requested a review September 7, 2022 10:10
zong-zhe
zong-zhe previously approved these changes Sep 7, 2022
Copy link
Contributor

@zong-zhe zong-zhe 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 force-pushed the doc_update_readme branch 2 times, most recently from e45b270 to 4ae0c70 Compare September 7, 2022 13:38
@ldxdl ldxdl self-requested a review September 7, 2022 15:27
ldxdl
ldxdl previously approved these changes Sep 7, 2022
zong-zhe
zong-zhe previously approved these changes Sep 8, 2022
README.md Outdated Show resolved Hide resolved
@Peefy Peefy force-pushed the doc_update_readme branch 2 times, most recently from 316fdd5 to 9144156 Compare September 8, 2022 08:10
Copy link
Contributor

@He1pa He1pa left a comment

Choose a reason for hiding this comment

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

lgtm

@ldxdl ldxdl merged commit a7b53c9 into kcl-lang:main Sep 8, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Sep 8, 2022
@Peefy Peefy deleted the doc_update_readme branch November 4, 2022 12:38
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.

6 participants