docs: update CONTRIBUTING.md #69
Conversation
SEMIN-97
requested review from
kimdaeyeobbb,
hy57in,
developerjhp,
bae-sh,
noahluftyang,
froggy1014,
heeji289 and
synuns
as code owners
|
WalkthroughSipe Design System의 기여 가이드라인 문서인 CONTRIBUTING.md가 대대적으로 재구성되었습니다. 문서는 더 명확하고 체계적인 구조로 변경되었으며, 새로운 섹션들(‘Side’ 소개, 개발, 컴포넌트 생성, 테스트, Storybook)이 추가되었습니다. 기여 방법, 이슈 보고, 기능 제안에 대한 상세한 지침이 포함되어 개발자들이 프로젝트에 더 쉽게 참여할 수 있도록 개선되었습니다. Changes
Possibly related PRs
Suggested reviewers
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 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: 3
🧹 Nitpick comments (3)
.github/CONTRIBUTING.md (3)
3-5: 중복된 문구 개선이 필요합니다"as easy and transparent as possible"이라는 문구가 반복되어 사용되고 있습니다. 다음과 같이 개선하는 것을 제안드립니다:
Welcome to our project! We want to make contributing to this project as easy and transparent as possible. -This document provides a clear guide on **how to contribute to Sipe Design System**. -We've outlined the process to ensure contributing is as easy and transparent as possible. +This document provides a clear guide on **how to contribute to Sipe Design System**, outlining the entire process.
42-47: 테스트 관련 요구사항을 더 구체적으로 명시해 주세요테스트 섹션에 다음 내용들을 추가하면 좋겠습니다:
- 필요한 테스트 커버리지 비율
- 단위 테스트와 통합 테스트의 구분
- 테스트 작성 시 모범 사례
1-102: 문서 전체의 언어 통일성 검토가 필요합니다PR 설명에서 언급된 것처럼, 문서 전체의 언어 사용에 대한 논의가 필요해 보입니다. 현재는 영어 헤더와 한글 컨텐츠가 혼용될 것으로 예상되는데, 다음 사항들을 고려해 주시면 좋겠습니다:
- 문서의 주 사용자층이 누구인지
- 향후 국제화 계획이 있는지
- 다른 문서들과의 일관성
|
|
||
| ## Creating a New Component | ||
| ### Bug Reporting |
There was a problem hiding this comment.
우리 이슈 템플릿도 몇 개 더 만들어야겠다.
There was a problem hiding this comment.
버그 리포트 템플릿은 바로 만들어볼게!
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
.github/CONTRIBUTING.md (3)
3-8: 한글 번역 추가를 제안드립니다프로젝트가 한국어 사용자를 대상으로 하는 만큼, 영문 내용과 함께 한글 번역을 추가하면 좋겠습니다. 특히 Side에 대한 소개 부분은 한글로도 이해하기 쉽게 작성되면 좋을 것 같습니다.
예시:
Welcome to our project! We want to make contributing to this project as easy and transparent as possible. +프로젝트에 오신 것을 환영합니다! 저희는 이 프로젝트에 대한 기여 과정을 최대한 쉽고 투명하게 만들고자 합니다. This document provides a clear guide on **how to contribute to Side(Sipe Design System)**. +이 문서는 **Side(Sipe Design System)에 기여하는 방법**에 대한 명확한 가이드를 제공합니다. ### What is Side? +### Side란? Side refers to the Sipe Design System, our primary UI component library aimed at creating consistent and reusable interfaces. +Side는 일관되고 재사용 가능한 인터페이스를 만들기 위한 우리의 주요 UI 컴포넌트 라이브러리인 Sipe Design System을 의미합니다.🧰 Tools
🪛 Markdownlint (0.37.0)
7-7: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
7-8: 마크다운 헤딩 레벨 구조를 수정해 주세요현재 h1에서 h3로 바로 건너뛰는 부분이 있습니다. 마크다운 문서의 구조적 일관성을 위해 헤딩 레벨을 순차적으로 증가시켜 주세요.
-### What is Side? +## What is Side?🧰 Tools
🪛 Markdownlint (0.37.0)
7-7: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
3-117: 문서 전체의 언어 사용을 통일해 주세요현재 문서가 영어로만 작성되어 있는데, PR 목표에서 언급된 것처럼 문서화 언어를 통일하는 것이 필요해 보입니다. 한글과 영어를 함께 사용하는 방식을 고려해 보시면 좋겠습니다.
제안:
- 모든 섹션에 한글 번역 추가
- 기술적인 용어는 영문을 괄호로 병기
- 예시 코드의 주석은 한글로 작성
🧰 Tools
🪛 Markdownlint (0.37.0)
7-7: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/CONTRIBUTING.md(1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
.github/CONTRIBUTING.md
7-7: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time
(MD001, heading-increment)
🔇 Additional comments (3)
.github/CONTRIBUTING.md (3)
16-18: Git 클론 URL에 대한 명확한 안내가 필요합니다현재 URL이 예시로만 제공되어 있어 사용자가 혼란스러울 수 있습니다. 실제 저장소 URL과 함께 포크 후 클론하는 과정을 더 자세히 설명하는 것이 좋겠습니다.
109-117: 이슈 템플릿 관련 안내가 필요합니다이슈 작성 시 사용할 수 있는 템플릿에 대한 안내를 추가하면 좋겠습니다. PR 목표에서 언급된 것처럼 버그 리포트 템플릿 생성도 고려해 보시기 바랍니다.
39-44: 🛠️ Refactor suggestion테스트 요구사항을 더 구체적으로 명시해 주세요
테스트 섹션에 최소 요구사항을 추가하면 기여자들이 더 명확한 기준을 가지고 테스트 코드를 작성할 수 있을 것 같습니다.
예시:
### Testing We use **Vitest** for testing. All new features or changes must include **relevant test cases**. + +#### 최소 테스트 요구사항: +- 주요 사용 사례에 대한 테스트 커버리지 확보 +- 엣지 케이스 테스트 포함 +- 컴포넌트의 모든 props에 대한 테스트 +- 사용자 인터랙션 테스트Likely invalid or redundant comment.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
.github/CONTRIBUTING.md (3)
7-8: 헤딩 레벨 구조 개선이 필요합니다
What is Side?섹션이 h3 레벨(###)로 되어 있어 문서 구조의 일관성이 떨어집니다. 상위 섹션들이 h2 레벨(##)이므로, 이 섹션도 h2로 수정하는 것이 좋겠습니다.-### What is Side? +## What is Side?🧰 Tools
🪛 Markdownlint (0.37.0)
7-7: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time(MD001, heading-increment)
36-37: 컴포넌트 네이밍 예시 추가 제안컴포넌트 네이밍 컨벤션에 대해 더 구체적인 예시가 있으면 좋겠습니다. 실제 프로젝트에서 사용되는 컴포넌트들을 예시로 추가해주세요.
- **Naming Convention:** Use kebab-case for component names (e.g., `my-button`). + **Naming Convention:** Use kebab-case for component names. Examples: + - `button-group` + - `input-field` + - `navigation-bar`
89-95: 커밋 메시지 가이드라인 보완 필요커밋 메시지 형식이 잘 정리되어 있으나, 실제 예시가 있으면 더 이해하기 쉬울 것 같습니다.
각 타입별 실제 예시를 추가해주세요:
예시: - feat(button): 클릭 이벤트 핸들러 추가 - fix(auth): 로그인 상태 체크 오류 수정 - docs(readme): 설치 가이드 업데이트 - style(component): 코드 포맷팅 적용
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/CONTRIBUTING.md(1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
.github/CONTRIBUTING.md
7-7: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time
(MD001, heading-increment)
🔇 Additional comments (1)
.github/CONTRIBUTING.md (1)
16-18: Git 클론 URL에 대한 명확한 안내가 필요합니다현재 URL이 예시로만 제공되어 있어 사용자가 혼란스러울 수 있습니다. 실제 저장소 URL과 함께 포크 후 클론하는 과정을 더 자세히 설명하는 것이 좋겠습니다.
Codecov ReportAll modified and coverable lines are covered by tests ✅ |
변경사항
기존 CONTRIBUTING.md 가이드의 내용을 보강했습니다.
시각자료
체크리스트
추가 논의사항
Summary by CodeRabbit