feat: add doc#174
Conversation
WalkthroughThis pull request enhances the documentation for the TinyEngine open source project. A new "Contributing" section is added to the Changes
Sequence Diagram(s)sequenceDiagram
participant Contributor
participant Repository
participant CodeReviewer
participant ProjectAdmin
Contributor->>Repository: Fork repository and clone locally
Contributor->>Repository: Submit pull request with changes
Repository->>CodeReviewer: Initiate code review process
CodeReviewer->>Contributor: Provide feedback
Contributor->>Repository: Update pull request (if needed)
CodeReviewer->>ProjectAdmin: Approve changes
ProjectAdmin->>Repository: Merge pull request
sequenceDiagram
participant User
participant IssueTracker
participant Developer
User->>IssueTracker: Select bug report template and submit details (version, screenshots, links)
IssueTracker->>Developer: Log bug for review
Developer->>User: Request additional information (if needed)
Poem
Tip 🌐 Web search-backed reviews and chat
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (8)
CONTRIBUTING.md (4)
1-8: Use Hyphenation for Compound Adjectives
In line 2 the phrase “TinyEngine open source project” is used as an adjective phrase. Consider changing it to “TinyEngine open‐source project” for proper hyphenation.🧰 Tools
🪛 LanguageTool
[uncategorized] ~2-~2: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...willing to contribute to the TinyEngine open source project. There are many forms of contri...(EN_COMPOUND_ADJECTIVE_INTERNAL)
35-40: Improve Pull Request Submission Wording
The “Pull Requests” section currently reads “Before submitting pull request, please make sure that your submission is in line with the overall plan of TinyEngine-backend-java.” Please consider:
• Adding the indefinite article (“a pull request”)
• Replacing “make sure that your submission is in line with” with a more concise phrase such as “ensure your submission aligns with”
• Using a shorter alternative instead of “overall plan” (e.g. “project guidelines”)
These tweaks will increase clarity and conciseness.🧰 Tools
🪛 LanguageTool
[uncategorized] ~37-~37: Possible missing article found.
Context: ...e ### Pull Requests Before submitting pull request, please make sure that your sub...(AI_HYDRA_LEO_MISSING_A)
[style] ~37-~37: Consider using a different verb to strengthen your wording.
Context: ... Before submitting pull request, please make sure that your submission is in line with th...(MAKE_SURE_ENSURE)
[style] ~37-~37: ‘overall plan’ might be wordy. Consider a shorter alternative.
Context: ...hat your submission is in line with the overall plan of TinyEngine-backend-java. Generally, ...(EN_WORDINESS_PREMIUM_OVERALL_PLAN)
🪛 markdownlint-cli2 (0.17.2)
40-40: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
41-46: Clarify Git Command Instructions
The instructions for cloning and setting up the repository can be improved for clarity. For example, “Clone personal warehouse to local” is unclear. Consider revising it to “Clone your forked repository locally.” Also, review the command block to ensure consistency and remove any duplicate phrasing.
61-67: Hyphenate Compound Adjectives in Community Section
In the “Join the open source community” section, phrases like “open source community” should use a hyphen when acting as a compound adjective. Consider updating to “open‐source community” for consistency.🧰 Tools
🪛 LanguageTool
[uncategorized] ~61-~61: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ou for your contribution! ### Join the open source community If you are interested in our ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~62-~62: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... community If you are interested in our open source projects, please join our open source c...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~62-~62: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...r open source projects, please join our open source community in the following ways. * Add...(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 markdownlint-cli2 (0.17.2)
65-65: Bare URL used
null(MD034, no-bare-urls)
README.zh-CN.md (2)
172-176: Standardize Node.js Spelling
In the database mapping section, the text uses “nodejs” (for example, “由nodejs的blocks__histories…”). Please update these occurrences to “Node.js” to reflect the proper branding.
1-7: Ensure Consistent Heading Levels
Although this file mostly contains content additions, please double-check that the heading levels increment by one level at a time as required by markdownlint.README.md (2)
11-17: Clarify Local Boot Steps Instructions
In the “Local Boot Steps” section:
• Hyphenate “upper-right corner” when referring to the repository’s interface.
• Replace “Clone personal warehouse to local” with “Clone your forked repository locally” for better clarity.
• Consider rephrasing “Modify the configuration of the connection database…” to “Update the database connection configuration in the tiny-engine-backend-java/app/src/main/resources/application-dev.yml file.”
These changes will make the instructions easier to follow.🧰 Tools
🪛 LanguageTool
[uncategorized] ~12-~12: Consider adding a hyphen.
Context: ...t Steps: * Click the Fork button in the upper right corner of the tiny-engine-backend-java ...(TOP_LEFT_CORNER)
169-176: Refine Database Mapping Descriptions
The description in the “Database table mapping before and after data migration” section is detailed but could be streamlined for readability. For instance:
• Replace “nodejs” with “Node.js”
• Simplify verbose phrases without losing meaning
This will help readers grasp the changes more quickly.🧰 Tools
🪛 LanguageTool
[uncategorized] ~172-~172: The official spelling of this programming framework is “Node.js”.
Context: ... refactored by the blocks__histories of nodejs, ref_id the block table associated with...(NODE_JS)
[uncategorized] ~175-~175: The official spelling of this programming framework is “Node.js”.
Context: ...ies_materials__materials_user_blocks of nodejs is used to find the primary key of the ...(NODE_JS)
[style] ~175-~175: Consider a shorter alternative to avoid wordiness.
Context: ...n the block table through the block_id, in order to query more conveniently. In the Java da...(IN_ORDER_TO_PREMIUM)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
logo.svgis excluded by!**/*.svg
📒 Files selected for processing (3)
CONTRIBUTING.md(1 hunks)README.md(1 hunks)README.zh-CN.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[uncategorized] ~2-~2: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...willing to contribute to the TinyEngine open source project. There are many forms of contri...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~37-~37: Possible missing article found.
Context: ...e ### Pull Requests Before submitting pull request, please make sure that your sub...
(AI_HYDRA_LEO_MISSING_A)
[style] ~37-~37: Consider using a different verb to strengthen your wording.
Context: ... Before submitting pull request, please make sure that your submission is in line with th...
(MAKE_SURE_ENSURE)
[style] ~37-~37: ‘overall plan’ might be wordy. Consider a shorter alternative.
Context: ...hat your submission is in line with the overall plan of TinyEngine-backend-java. Generally, ...
(EN_WORDINESS_PREMIUM_OVERALL_PLAN)
[uncategorized] ~49-~49: Consider adding a hyphen.
Context: ...t a PR: * Click the Fork button in the upper right corner of the tiny-engine-backend-java ...
(TOP_LEFT_CORNER)
[duplication] ~50-~50: Possible typo: you repeated a word.
Context: ...pository. * Clone personal warehouse to local * Local coding. * Submit according to Commit Me...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~52-~52: There seems to be a noun/verb agreement error. Did you mean “does not” or “did not”?
Context: ...t Message Format specification. PR that do not conform to the submission specification...
(SINGULAR_NOUN_AGREEMENT_WHO_DO_NOT)
[uncategorized] ~61-~61: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ou for your contribution! ### Join the open source community If you are interested in our ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~62-~62: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... community If you are interested in our open source projects, please join our open source c...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~62-~62: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...r open source projects, please join our open source community in the following ways. * Add...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
README.md
[uncategorized] ~12-~12: Consider adding a hyphen.
Context: ...t Steps: * Click the Fork button in the upper right corner of the tiny-engine-backend-java ...
(TOP_LEFT_CORNER)
[uncategorized] ~172-~172: The official spelling of this programming framework is “Node.js”.
Context: ... refactored by the blocks__histories of nodejs, ref_id the block table associated with...
(NODE_JS)
[uncategorized] ~175-~175: The official spelling of this programming framework is “Node.js”.
Context: ...ies_materials__materials_user_blocks of nodejs is used to find the primary key of the ...
(NODE_JS)
[style] ~175-~175: Consider a shorter alternative to avoid wordiness.
Context: ...n the block table through the block_id, in order to query more conveniently. In the Java da...
(IN_ORDER_TO_PREMIUM)
[style] ~183-~183: ‘taking into account’ might be wordy. Consider a shorter alternative.
Context: ...tion were merged into a block grouping, taking into account the similar functions and functions of ...
(EN_WORDINESS_PREMIUM_TAKING_INTO_ACCOUNT)
[uncategorized] ~217-~217: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...utions Q If you are interested in our open source project, please join us! Please read [...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~224-~224: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ing list opentiny@googlegroups.com ### Open source protocol MIT
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 markdownlint-cli2 (0.17.2)
CONTRIBUTING.md
17-17: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
40-40: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
65-65: Bare URL used
null
(MD034, no-bare-urls)
🔇 Additional comments (3)
README.zh-CN.md (1)
214-216: Review Platform and Platform History Mappings
The new rows added for “platforms” and “platform_histories” appear to capture important schema changes. Please verify that:
• The conversion of naming conventions (e.g. using snake_case) is consistent with other mappings
• The table formatting (column alignment and spacing) remains clear for readers
If needed, consider minor reformatting to improve readability.README.md (2)
187-213: Verify Consistency in Database Mapping Table
The extensive table mapping legacy Node.js tables to Java database tables is very informative. Please ensure that:
• All naming transformations (camelCase to snake_case) are applied consistently
• The table layout remains readable on various devices (consider a reformat or scrollable table if needed)
This will help maintain consistency and usability in your documentation.
217-227: Confirm Contribution Section Clarity
The final sections for “Participating in contributions” and “Open source protocol” are clear and concise. No changes are required here.🧰 Tools
🪛 LanguageTool
[uncategorized] ~217-~217: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...utions Q If you are interested in our open source project, please join us! Please read [...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~224-~224: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ing list opentiny@googlegroups.com ### Open source protocol MIT(EN_COMPOUND_ADJECTIVE_INTERNAL)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (12)
README.md (12)
9-17: Improve "Local Boot Steps" Clarity.
Consider rephrasing or adding a hyphen for clarity—for example, change "Local Boot Steps:" to "Local-Boot Steps:" or "Local Boot-Up Steps:" per style advice.🧰 Tools
🪛 LanguageTool
[uncategorized] ~12-~12: Consider adding a hyphen.
Context: ...t Steps: * Click the Fork button in the upper right corner of the tiny-engine-backend-java ...(TOP_LEFT_CORNER)
24-40: Specify Code Block Language.
For better syntax highlighting and to comply with markdown best practices, add a language specifier (e.g.,plaintextorbash) to the fenced code block displaying the directory structure.-``` +```plaintext🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
24-24: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
127-127: Adjust Heading Level for "1.Return Format".
The header currently uses five hash marks (h5) following an h3 section; consider reducing it to four hash marks (h4) so the heading levels increment by one.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
127-127: Heading levels should only increment by one level at a time
Expected: h4; Actual: h5(MD001, heading-increment)
129-129: Standardize Unordered List Markers.
Replace the dash (“-”) with an asterisk (“*”) for the list item labeling “Correct data” to follow the markdown guideline for unordered lists.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
129-129: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
143-143: Standardize Unordered List Markers.
Similarly, update the bullet for “Error Data” from a dash to an asterisk for consistency with the rest of the document.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
143-143: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
163-163: Remove Trailing Punctuation in Heading.
The heading "Local Runtime Configuration:" ends with a colon. Removing it (to read "Local Runtime Configuration") will yield a cleaner header.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
163-163: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
171-176: Unify List Formatting for Migration Details.
In the database migration section, update the list markers (currently dashes) to asterisks (*) to maintain consistent markdown formatting throughout the document.🧰 Tools
🪛 LanguageTool
[uncategorized] ~172-~172: The official spelling of this programming framework is “Node.js”.
Context: ... refactored by the blocks__histories of nodejs, ref_id the block table associated with...(NODE_JS)
[uncategorized] ~175-~175: The official spelling of this programming framework is “Node.js”.
Context: ...ies_materials__materials_user_blocks of nodejs is used to find the primary key of the ...(NODE_JS)
[style] ~175-~175: Consider a shorter alternative to avoid wordiness.
Context: ...n the block table through the block_id, in order to query more conveniently. In the Java da...(IN_ORDER_TO_PREMIUM)
🪛 markdownlint-cli2 (0.17.2)
171-171: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
174-174: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
179-185: Ensure Consistent List Style in Migration Points.
For the subsequent list items detailing the changes (e.g., field standardization, attribute modifications), please use asterisks (“*”) rather than dashes (“-”) for improved consistency and readability.🧰 Tools
🪛 LanguageTool
[style] ~183-~183: ‘taking into account’ might be wordy. Consider a shorter alternative.
Context: ...tion were merged into a block grouping, taking into account the similar functions and functions of ...(EN_WORDINESS_PREMIUM_TAKING_INTO_ACCOUNT)
🪛 markdownlint-cli2 (0.17.2)
179-179: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
180-180: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
181-181: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
182-182: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
183-183: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
184-184: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
187-190: Correct Framework Spelling.
Within the table headers and descriptions, replace “nodejs” with the officially styled “Node.js” for accuracy and consistency.🧰 Tools
🪛 LanguageTool
[uncategorized] ~187-~187: The official spelling of this programming framework is “Node.js”.
Context: ...e reserved, and r_material_category | nodejs database tables | Java databa...(NODE_JS)
217-217: Clarify "Participating in Contributions" Heading.
The heading "Participating in contributions Q" appears to include extra spacing and an ambiguous “Q”. Consider rewording it to simply “### 🤝 Participating in Contributions” to improve clarity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~217-~217: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...utions Q If you are interested in our open source project, please join us! Please read [...(EN_COMPOUND_ADJECTIVE_INTERNAL)
221-222: Standardize Bullet List Formatting.
For the contribution guidelines (e.g., “Add official assistant WeChat…”, “Join the mailing list…”), switch from dashes (“-”) to asterisks (“*”) to conform with the document’s markdown style.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
221-221: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
222-222: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
222-222: Bare URL used
null(MD034, no-bare-urls)
224-227: Hyphenate Compound Adjective in Heading.
Consider changing “Open source protocol” to “Open‑Source Protocol” to correctly format the compound adjective, which enhances clarity and adheres to style guidelines.🧰 Tools
🪛 LanguageTool
[uncategorized] ~224-~224: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ing list opentiny@googlegroups.com ### Open source protocol MIT(EN_COMPOUND_ADJECTIVE_INTERNAL)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~12-~12: Consider adding a hyphen.
Context: ...t Steps: * Click the Fork button in the upper right corner of the tiny-engine-backend-java ...
(TOP_LEFT_CORNER)
[uncategorized] ~172-~172: The official spelling of this programming framework is “Node.js”.
Context: ... refactored by the blocks__histories of nodejs, ref_id the block table associated with...
(NODE_JS)
[uncategorized] ~175-~175: The official spelling of this programming framework is “Node.js”.
Context: ...ies_materials__materials_user_blocks of nodejs is used to find the primary key of the ...
(NODE_JS)
[style] ~175-~175: Consider a shorter alternative to avoid wordiness.
Context: ...n the block table through the block_id, in order to query more conveniently. In the Java da...
(IN_ORDER_TO_PREMIUM)
[style] ~183-~183: ‘taking into account’ might be wordy. Consider a shorter alternative.
Context: ...tion were merged into a block grouping, taking into account the similar functions and functions of ...
(EN_WORDINESS_PREMIUM_TAKING_INTO_ACCOUNT)
[uncategorized] ~187-~187: The official spelling of this programming framework is “Node.js”.
Context: ...e reserved, and r_material_category | nodejs database tables | Java databa...
(NODE_JS)
[uncategorized] ~217-~217: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...utions Q If you are interested in our open source project, please join us! Please read [...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~224-~224: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ing list opentiny@googlegroups.com ### Open source protocol MIT
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 markdownlint-cli2 (0.17.2)
README.md
24-24: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
127-127: Heading levels should only increment by one level at a time
Expected: h4; Actual: h5
(MD001, heading-increment)
129-129: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
143-143: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
163-163: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
171-171: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
174-174: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
179-179: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
180-180: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
181-181: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
182-182: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
183-183: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
184-184: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
221-221: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
222-222: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
222-222: Bare URL used
null
(MD034, no-bare-urls)
🔇 Additional comments (1)
README.md (1)
1-7: Logo Section is well-formatted.
The centered logo HTML block is clear, uses appropriate attributes, and ensures responsiveness.
* feat: add doc * modify doc
2 participants
English | 简体中文
PR
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
Background and solution
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information
Summary by CodeRabbit