Add MAINTAINING.md #150
Add MAINTAINING.md #150
Conversation
WalkthroughThe recent updates enhance the Changes
Poem
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 as PR comments)
Additionally, you can add 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: 2
Outside diff range, codebase verification and nitpick comments (1)
MAINTAINING.md (1)
9-9: Improve the link for creating a pull request.Provide a more specific link for creating a pull request.
- Create [Pull Request](https://github.com/yorkie-team/yorkie-ui/commits/main/package.json) and merge it into main. + Create a [Pull Request](https://github.com/yorkie-team/yorkie-ui/compare) and merge it into main.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- MAINTAINING.md (1 hunks)
- apps/storybook/src/stories/Introduction.mdx (1 hunks)
- packages/core/README.md (1 hunks)
Files skipped from review due to trivial changes (1)
- packages/core/README.md
Additional context used
Markdownlint
MAINTAINING.md
5-5: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
11-11: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
15-15: null
Bare URL used(MD034, no-bare-urls)
Additional comments not posted (2)
apps/storybook/src/stories/Introduction.mdx (1)
22-22: Verify the correctness of the new import path.Ensure that the new import path
@yorkie-ui/core/styles.cssis correct and does not break the functionality. Verify that thestyles.cssfile exists at the specified location.MAINTAINING.md (1)
29-31: LGTM!The deployment section is clear and correctly references the GitHub action for deployment.
|
|
||
| 1. Click on `Releases` in GitHub, then click the `Draft a new release` button. | ||
|
|
||
| Alternatively, you can directly access this link: https://github.com/yorkie-team/yorkie-ui/releases/new |
There was a problem hiding this comment.
Format the bare URL correctly.
The bare URL should be formatted as a proper link.
- Alternatively, you can directly access this link: https://github.com/yorkie-team/yorkie-ui/releases/new
+ Alternatively, you can directly access this link: [GitHub Releases](https://github.com/yorkie-team/yorkie-ui/releases/new)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.
| Alternatively, you can directly access this link: https://github.com/yorkie-team/yorkie-ui/releases/new | |
| Alternatively, you can directly access this link: [GitHub Releases](https://github.com/yorkie-team/yorkie-ui/releases/new) |
Tools
Markdownlint
15-15: null
Bare URL used(MD034, no-bare-urls)
|
|
||
| ## Releasing a New Version | ||
|
|
||
| ### 1. Update the version number. |
There was a problem hiding this comment.
Remove trailing punctuation in the heading.
The heading should not have trailing punctuation.
-### 1. Update the version number.
+### 1. Update the version numberCommittable 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.
| ### 1. Update the version number. | |
| ### 1. Update the version number |
Tools
Markdownlint
5-5: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
What this PR does / why we need it:
Add MAINTAINING.md
Special notes for your reviewer:
Which issue(s) this PR fixes:
Fixes #
Checklist:
Summary by CodeRabbit
New Features
MAINTAINING.mdfile detailing procedures for versioning, release, and deployment for theyorkie-uiproject.Improvements
Introduction.mdxandREADME.mdfiles for better organization and clarity.Documentation