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

Translate and overwrite content of README.md into English readme #358

Merged
merged 1 commit into from
Jul 15, 2024

Conversation

newbe36524
Copy link
Contributor

@newbe36524 newbe36524 commented Jul 15, 2024

Related to #357

Translate and overwrite the content of README.md into the corresponding English readme file.

  • Translate the content of the main readme file, README.md, into English.
  • Overwrite the content of the English readme file, lang/english/README.md, with the translated content.
  • Ensure that the English readme file contains the same detailed information as the main readme file, including performance tests, sponsorship details, and donation records.
  • Verify that the English readme file provides a comprehensive overview of the project, similar to the main readme file.

For more details, open the Copilot Workspace session.

Summary by CodeRabbit

  • Documentation
    • Enhanced README with feedback and documentation improvement notes.
    • Updated project badges and links, including a new badge for the wiki.
    • Added performance test updates and a new sponsorship section.
    • Restructured and added content related to the library.

Copy link

coderabbitai bot commented Jul 15, 2024

Walkthrough

The updates to the lang/english/README.md file notably include the addition of feedback and documentation improvement notes, new and updated badges, content restructuring related to the library, performance test updates, and a new sponsorship section. Moreover, new declarations for a wiki link and two new methods in the Natasha class were added.

Changes

File Change Summary
lang/english/README.md Added feedback and documentation notes; updated badges and links; restructured content; added performance tests and sponsorship section
src/.../README.md Added var wiki = "https://natasha.dotnetcore.xyz/"; added dynamic_assembly_builder(...) and sponsorship_section(...) methods in the Natasha class

Poem

In the README, changes unfold,
With links and badges, bright and bold.
The library grows with grace and care,
New methods and notes are everywhere.
Sponsors to cheer, performance to test,
Natasha's updates are simply the best! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Outside diff range, codebase verification and nitpick comments (1)
lang/english/README.md (1)

11-22: Project badges and links look good, but reduce excessive exclamation marks.

The badges and links are correct, but using many exclamation marks might seem excessive.

- [![NuGet Badge](https://buildstats.info/nuget/DotNetCore.Natasha.CSharp.Compiler?includePreReleases=true)](https://www.nuget.org/packages/DotNetCore.Natasha.CSharp.Compiler)
Tools
LanguageTool

[style] ~19-~19: Using many exclamation marks might seem excessive (in this case: 8 exclamation marks for a text that’s 1671 characters long)
Context: ...ges/DotNetCore.Natasha.CSharp.Compiler) GitHub commit activity [![Codecov](https://img.shields.io/codecov...

(EN_EXCESSIVE_EXCLAMATION)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 751ba3c and 7846efb.

Files selected for processing (1)
  • lang/english/README.md (2 hunks)
Additional context used
LanguageTool
lang/english/README.md

[style] ~19-~19: Using many exclamation marks might seem excessive (in this case: 8 exclamation marks for a text that’s 1671 characters long)
Context: ...ges/DotNetCore.Natasha.CSharp.Compiler) GitHub commit activity [![Codecov](https://img.shields.io/codecov...

(EN_EXCESSIVE_EXCLAMATION)

Markdownlint
lang/english/README.md

33-33: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time

(MD001, heading-increment)


35-35: Expected: 0; Actual: 3
Unordered list indentation

(MD007, ul-indent)


37-37: Expected: 0; Actual: 3
Unordered list indentation

(MD007, ul-indent)


43-43: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


45-45: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


45-45: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

Additional comments not posted (3)
lang/english/README.md (3)

5-6: Feedback and documentation notes look good.

The content is clear and the links are correct.


25-28: Project description looks good.

The content is clear and accurate.


75-75: License information looks good.

The content is clear and the badge is correctly linked.

Comment on lines +33 to +38
### Performance Tests

- [x] **动态初始化性能测试(对照组: emit, origin**
![初始化性能测试](https://images.gitee.com/uploads/images/2020/1201/161738_b54dd1ad_1478282.png)
- [x] **内存及CPU监测截图**
![内存及CPU](https://images.gitee.com/uploads/images/2020/1201/161450_96e70709_1478282.png)
- [x] **Dynamic Initialization Performance Test (Comparison Group: emit, origin)**
![Initialization Performance Test](https://images.gitee.com/uploads/images/2020/1201/161738_b54dd1ad_1478282.png)
- [x] **Memory and CPU Monitoring Screenshot**
![Memory and CPU](https://images.gitee.com/uploads/images/2020/1201/161450_96e70709_1478282.png)
Copy link

Choose a reason for hiding this comment

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

Fix heading level and unordered list indentation.

The heading levels should only increment by one level at a time and the unordered list indentation is incorrect.

- ### Performance Tests
+ ## Performance Tests

-   - [x]  **Dynamic Initialization Performance Test (Comparison Group: emit, origin)**  
+ - [x]  **Dynamic Initialization Performance Test (Comparison Group: emit, origin)**  
-     ![Initialization Performance Test](https://images.gitee.com/uploads/images/2020/1201/161738_b54dd1ad_1478282.png)
+   ![Initialization Performance Test](https://images.gitee.com/uploads/images/2020/1201/161738_b54dd1ad_1478282.png)
-   - [x]  **Memory and CPU Monitoring Screenshot**  
+ - [x]  **Memory and CPU Monitoring Screenshot**  
-     ![Memory and CPU](https://images.gitee.com/uploads/images/2020/1201/161450_96e70709_1478282.png)      
+   ![Memory and CPU](https://images.gitee.com/uploads/images/2020/1201/161450_96e70709_1478282.png)      
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### Performance Tests
- [x] **动态初始化性能测试(对照组: emit, origin)**
![初始化性能测试](https://images.gitee.com/uploads/images/2020/1201/161738_b54dd1ad_1478282.png)
- [x] **内存及CPU监测截图**
![内存及CPU](https://images.gitee.com/uploads/images/2020/1201/161450_96e70709_1478282.png)
- [x] **Dynamic Initialization Performance Test (Comparison Group: emit, origin)**
![Initialization Performance Test](https://images.gitee.com/uploads/images/2020/1201/161738_b54dd1ad_1478282.png)
- [x] **Memory and CPU Monitoring Screenshot**
![Memory and CPU](https://images.gitee.com/uploads/images/2020/1201/161450_96e70709_1478282.png)
## Performance Tests
- [x] **Dynamic Initialization Performance Test (Comparison Group: emit, origin)**
![Initialization Performance Test](https://images.gitee.com/uploads/images/2020/1201/161738_b54dd1ad_1478282.png)
- [x] **Memory and CPU Monitoring Screenshot**
![Memory and CPU](https://images.gitee.com/uploads/images/2020/1201/161450_96e70709_1478282.png)
Tools
Markdownlint

33-33: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time

(MD001, heading-increment)


35-35: Expected: 0; Actual: 3
Unordered list indentation

(MD007, ul-indent)


37-37: Expected: 0; Actual: 3
Unordered list indentation

(MD007, ul-indent)

Comment on lines +43 to +65
### Sponsorship:

<img width=200 height=200 src="https://images.gitee.com/uploads/images/2020/1201/163955_a29c0b44_1478282.png" title="Scan and donate"/><img width=200 height=200 src="https://images.gitee.com/uploads/images/2020/1201/164809_5a67d5e2_1478282.png" title="Scan and donate"/>


#### 捐助明细

- ****天下 10元
- **航 5元

#### Donation Details

- L*u 50 yuan
- Liang 20 yuan
- Shengxunwei Online Customer Service System 5 yuan
- Json-jh [Honorable VIP Member of Blog Park] 22 yuan
- [Newbe Yulao](https://github.com/newbe36524) 90.2 yuan
- Cui Xingxing 17 yuan
- Money 100 yuan
- [Newbe Yulao](https://github.com/newbe36524) 200 yuan
- iNeuOS Industrial Internet Platform 100 yuan
- Lao Meng 30 yuan
- ****Tianxia 10 yuan
- Wenhang 5 yuan
- TonyQu 10 yuan
- Rwing 20 yuan

Thank you for your support, much appreciated 🙏🙏🙏.
Copy link

Choose a reason for hiding this comment

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

Fix trailing punctuation in heading and add alt text for images.

The heading has trailing punctuation and the images should have alternate text.

- ### Sponsorship:
+ ### Sponsorship

- <img width=200 height=200 src="https://images.gitee.com/uploads/images/2020/1201/163955_a29c0b44_1478282.png" title="Scan and donate"/><img width=200 height=200 src="https://images.gitee.com/uploads/images/2020/1201/164809_5a67d5e2_1478282.png" title="Scan and donate"/>
+ <img width=200 height=200 src="https://images.gitee.com/uploads/images/2020/1201/163955_a29c0b44_1478282.png" alt="Scan and donate" title="Scan and donate"/><img width=200 height=200 src="https://images.gitee.com/uploads/images/2020/1201/164809_5a67d5e2_1478282.png" alt="Scan and donate" title="Scan and donate"/>
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### Sponsorship:
<img width=200 height=200 src="https://images.gitee.com/uploads/images/2020/1201/163955_a29c0b44_1478282.png" title="Scan and donate"/><img width=200 height=200 src="https://images.gitee.com/uploads/images/2020/1201/164809_5a67d5e2_1478282.png" title="Scan and donate"/>
#### 捐助明细
- ****天下 10元
- **航 5元
#### Donation Details
- L*u 50 yuan
- Liang 20 yuan
- Shengxunwei Online Customer Service System 5 yuan
- Json-jh [Honorable VIP Member of Blog Park] 22 yuan
- [Newbe Yulao](https://github.com/newbe36524) 90.2 yuan
- Cui Xingxing 17 yuan
- Money 100 yuan
- [Newbe Yulao](https://github.com/newbe36524) 200 yuan
- iNeuOS Industrial Internet Platform 100 yuan
- Lao Meng 30 yuan
- ****Tianxia 10 yuan
- Wenhang 5 yuan
- TonyQu 10 yuan
- Rwing 20 yuan
Thank you for your support, much appreciated 🙏🙏🙏.
### Sponsorship
<img width=200 height=200 src="https://images.gitee.com/uploads/images/2020/1201/163955_a29c0b44_1478282.png" alt="Scan and donate" title="Scan and donate"/><img width=200 height=200 src="https://images.gitee.com/uploads/images/2020/1201/164809_5a67d5e2_1478282.png" alt="Scan and donate" title="Scan and donate"/>
#### Donation Details
- L*u 50 yuan
- Liang 20 yuan
- Shengxunwei Online Customer Service System 5 yuan
- Json-jh [Honorable VIP Member of Blog Park] 22 yuan
- [Newbe Yulao](https://github.com/newbe36524) 90.2 yuan
- Cui Xingxing 17 yuan
- Money 100 yuan
- [Newbe Yulao](https://github.com/newbe36524) 200 yuan
- iNeuOS Industrial Internet Platform 100 yuan
- Lao Meng 30 yuan
- ****Tianxia 10 yuan
- Wenhang 5 yuan
- TonyQu 10 yuan
- Rwing 20 yuan
Thank you for your support, much appreciated 🙏🙏🙏.
Tools
Markdownlint

43-43: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


45-45: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


45-45: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

@NMSAzulX NMSAzulX merged commit 640071a into dotnetcore:main Jul 15, 2024
1 check passed
@newbe36524 newbe36524 deleted the translate-readme branch July 15, 2024 13:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants