Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,36 +100,36 @@ Before proposing changes, please **open an issue** to discuss the bug or feature
### Create a Pull Request

1. **Create a Branch**
Follow the branch naming convention: `<CATEGORY>/<ISSUENUMBER>-<SUBJECT>` (`ISSUENUMBER` is optional)
Follow the branch naming convention: `<CATEGORY>/<SUBJECT>-<USERNAME>`
- `USERNAME` is required (at least one hyphen must be present)
```bash
git checkout -b your-branch
git checkout -b feature/button-john
```

| **Category** | **Description** |
|--------------|-----------------------------------------------------|
| **feat** | Developing a new feature |
| **fix** | Fixing a bug |
| **hotfix** | Emergency fixes for immediate release |
| **chore** | Maintenance tasks or minor updates |
| **refactor** | Code refactoring without functional changes |
| **release** | Preparing for a new release version |
| **test** | Writing or modifying test cases |
| **docs** | Documentation updates or additions |
| **ci** | CI/CD pipeline updates |
| **build** | Changes to the build system or dependencies |
| **Category** | **Description** |
|---------------|-----------------------------------------------------|
| **feature** | Developing a new feature |
| **fix** | Fixing a bug |
| **docs** | Documentation updates or additions |
| **style** | Code style changes (formatting, no logic change) |
| **refactor** | Code refactoring without functional changes |
| **test** | Writing or modifying test cases |
| **deploy** | Deployment-related changes |
| **chore** | Maintenance tasks or minor updates |
| **settings** | Configuration or settings changes |

2. **Commit Changes**
Write meaningful commit messages using the [Conventional Commits](https://www.conventionalcommits.org/) format:
```bash
git commit -m "<type>(<scope>): <subject>"
```
We recommend following the Conventional Commits standard for clear and consistent commit messages. Below is the suggested structure:
We follow the [Conventional Commits](https://www.conventionalcommits.org/) standard with [`@commitlint/config-conventional`](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional):

| Element | Requirement | Description |
|--------------|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `<type>` | **Required** | Describes the purpose of the commit. Examples: `feat`, `fix`, `docs`, `style`, `refactor`, `test` |
| `<scope>` | **Optional** | Specifies the affected module, file, or functionality. Limited to **20 characters** (e.g., `auth`, `header`). |
| `<subject>` | **Required** | A concise summary of the changes<br/> - Starts with a lowercase letter<br/> - Avoid ending with a period (.)<br/> - Limited to **50 characters**<br/> - Must contain only English characters, numbers, and basic punctuation (!@#$%^&*(),.?":{}|<>_-)<br/> - Cannot be empty |
| `<type>` | **Required** | Describes the purpose of the commit: `build`, `chore`, `ci`, `docs`, `feat`, `fix`, `perf`, `refactor`, `revert`, `style`, `test` |
| `<scope>` | **Optional** | Specifies the affected module, file, or functionality (e.g., `auth`, `header`). |
| `<subject>` | **Required** | A concise summary of the changes<br/> - Starts with a lowercase letter<br/> - Avoid ending with a period (.)<br/> - Cannot be empty |



Expand Down
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ strict TypeScript를 사용하고, 각 패키지의 `src/index.ts`에서 공개

## 커밋 및 PR 가이드라인

`feat(chip): add removable variant`와 같은 Conventional Commits를 사용하세요. scope는 짧게, subject는 영어로, `commitlint.config.ts`를 만족하도록 50자 이내로 작성하세요. PR은 `.github/PULL_REQUEST_TEMPLATE.md`를 따르세요: 변경 사항 요약, UI 변경 시 시각 자료 첨부, 스펙과 테스트 추가 여부 확인. 배포 패키지에 영향을 주는 변경이면 `.changeset` 항목을 포함하고 PR 설명에 릴리스 영향을 명시하세요.
[Conventional Commits](https://www.conventionalcommits.org/) 사용. 커밋 타입: `build | chore | ci | docs | feat | fix | perf | refactor | revert | style | test` ([`config-conventional`](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) 기준). 브랜치: `<CATEGORY>/<SUBJECT>-<USERNAME>` (하이픈 최소 1개). 카테고리: `feature | fix | docs | style | refactor | test | deploy | chore | settings`. 특수 브랜치 `main`, `dev/*`는 규칙 제외. PR은 `.github/PULL_REQUEST_TEMPLATE.md` 준수. 배포 패키지 변경 시 `.changeset` 항목 포함.
8 changes: 5 additions & 3 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,14 @@ export type ButtonSize = (typeof ButtonSize)[keyof typeof ButtonSize];

## 커밋 컨벤션

형식: `type(scope): subject` — 영어만, subject 최대 50자, scope 최대 20자.
타입: feat, fix, hotfix, chore, refactor, release, test, docs, ci, build.
`type(scope): subject` — [conventional commits](https://www.conventionalcommits.org/) + [`config-conventional`](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional).
타입: `build | chore | ci | docs | feat | fix | perf | refactor | revert | style | test`

## 브랜치 네이밍

`<CATEGORY>/<ISSUENUMBER>-<SUBJECT>` (이슈 번호는 선택)
`<CATEGORY>/<SUBJECT>-<USERNAME>` — 하이픈 최소 1개 필수.
카테고리: `feature | fix | docs | style | refactor | test | deploy | chore | settings`
특수: `main`, `dev/*`

## 배포

Expand Down
Loading