Skip to content

i18n(ko-KR): create code-contributions.mdx#86

Merged
Adammatthiesen merged 1 commit into
withstudiocms:mainfrom
jsparkdev:con-code
Apr 18, 2025
Merged

i18n(ko-KR): create code-contributions.mdx#86
Adammatthiesen merged 1 commit into
withstudiocms:mainfrom
jsparkdev:con-code

Conversation

@jsparkdev
Copy link
Copy Markdown
Contributor

@jsparkdev jsparkdev commented Apr 18, 2025

Description

create code-contributions.mdx

Summary by CodeRabbit

  • Documentation
    • Added a new Korean-language guide for contributing code, outlining the workflow for issues, pull requests, reviews, and merging, with step-by-step instructions and helpful links for new contributors.

@jsparkdev jsparkdev requested a review from a team as a code owner April 18, 2025 03:40
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 18, 2025

Walkthrough

A new Korean-language documentation page titled "코드 기여" (Code Contributions) has been introduced. This page provides a comprehensive guide for contributing code to the StudioCMS project, detailing the process from finding issues to submitting and reviewing pull requests, resolving conflicts, and joining the community. The documentation uses step-by-step instructions, includes relevant links, and employs a step component to structure the contribution workflow.

Changes

File(s) Change Summary
src/content/docs/ko/contributing/code-contributions.mdx Added a new Korean documentation page outlining the code contribution workflow, including issue tracking, PR creation, review, and community engagement.

Suggested labels

i18n

Suggested reviewers

  • Adammatthiesen

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

@studiocms-no-reply
Copy link
Copy Markdown
Member

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
ko/contributing/code-contributions.mdx Localization added, will be marked as complete.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

Copy link
Copy Markdown
Contributor

@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: 0

🧹 Nitpick comments (2)
src/content/docs/ko/contributing/code-contributions.mdx (2)

53-59: Reduce excessive exclamation usage
The celebratory tone is great, but multiple exclamation marks can feel informal in official documentation. Consider removing or replacing one of them to maintain a more professional tone.

🧰 Tools
🪛 LanguageTool

[style] ~59-~59: Using many exclamation marks might seem excessive (in this case: 4 exclamation marks for a text that’s 2222 characters long)
Context: ...자 목록][contributors]에서 여러분의 모습을 보실 수 있습니다! 🎉 {/* Links */} [contributors]: /ko/c...

(EN_EXCESSIVE_EXCLAMATION)


61-63: Use HTML comments for link definitions
Instead of the JSX comment {/* Links */}, using an HTML comment like <!-- Links --> will keep the MDX footnote section consistent with standard markdown practices.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2bdf1e5 and 55dda9c.

📒 Files selected for processing (1)
  • src/content/docs/ko/contributing/code-contributions.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/content/docs/ko/contributing/code-contributions.mdx

[style] ~59-~59: Using many exclamation marks might seem excessive (in this case: 4 exclamation marks for a text that’s 2222 characters long)
Context: ...자 목록][contributors]에서 여러분의 모습을 보실 수 있습니다! 🎉 {/* Links */} [contributors]: /ko/c...

(EN_EXCESSIVE_EXCLAMATION)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Run Starlight Link Check
🔇 Additional comments (5)
src/content/docs/ko/contributing/code-contributions.mdx (5)

1-7: Frontmatter configuration is correct
The YAML frontmatter (i18nReady, title, description, sidebar.order) looks well‑formed and aligned with the project’s conventions.


9-9: Verify the Steps import path
You’ve imported Steps from @astrojs/starlight/components. Please ensure that this alias is correctly configured in the Astro project (e.g., via tsconfig.json or Astro config) and that the package is installed.


11-18: Intro and issue resolution steps readability
The translated introduction and “이슈 해결” section are clear, concise, and faithful to the intended workflow. Nice work!


21-37: Steps component content
The <Steps> block and its nested lists are well‑structured. The indentation and numbered items render clearly in MDX.


39-46: Verify heading translation against English source
The heading “## 업데이트 커밋” may need to exactly mirror the original English heading (e.g., “## Commit updates” or “## Updating commits”). Please confirm that this phrasing aligns with the upstream docs.

@Adammatthiesen Adammatthiesen merged commit e351878 into withstudiocms:main Apr 18, 2025
8 checks passed
@jsparkdev jsparkdev deleted the con-code branch April 18, 2025 04:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants