Skip to content

[Feature] AGENTS.md 코딩 규칙 추가#1399

Open
KYM-P wants to merge 1 commit intodevelopfrom
feature/1398-agents-md-rule
Open

[Feature] AGENTS.md 코딩 규칙 추가#1399
KYM-P wants to merge 1 commit intodevelopfrom
feature/1398-agents-md-rule

Conversation

@KYM-P
Copy link
Copy Markdown
Collaborator

@KYM-P KYM-P commented Mar 30, 2026

PR 개요

이슈 번호: #1398

PR 체크리스트

  • Code convention을 잘 지켰나요?
  • Lint check를 수행하였나요?
  • Assignees를 추가했나요?

작업사항

  • 버그 수정
  • 신규 기능
  • 코드 스타일 수정 (포맷팅 등)
  • 리팩토링 (기능 수정 X, API 수정 X)
  • 기타

작업사항의 상세한 설명

AGENTS.md에 다음 코딩 규칙을 추가:

  • General UI Rules: 터치 영역 48dp 미만 허용, contentDescription null/빈문자열 모두 허용
  • Import Order: import 순서는 ktlint 강제 순서를 따름
  • Mapper / Conversion Code: mapper 로직은 Mapper 파일, Util 파일, 또는 대상 객체 파일에 선언

논의 사항

스크린샷

추가내용

  • develop, sprint 브랜치를 향하고 있습니다
  • production 브랜치를 향하고 있습니다

Summary by CodeRabbit

  • 문서
    • UI 가이드라인(터치 대상 및 콘텐츠 설명)이 추가되었습니다.
    • 가져오기 순서 규칙이 정의되었습니다.
    • 매퍼 및 변환 코드 구성 지침이 추가되었습니다.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@KYM-P KYM-P requested a review from a team as a code owner March 30, 2026 07:03
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 30, 2026

Walkthrough

AGENTS.md에 세 가지 새로운 규칙 섹션을 추가했습니다: 소형 아이콘/버튼 터치 대상 크기(48dp 이상) 및 contentDescription 처리에 관한 일반 UI 규칙, ktlint 기반 import 순서 요구사항, 그리고 매퍼/변환 로직 위치 제한 규칙입니다.

Changes

Cohort / File(s) Summary
Documentation Guidelines
AGENTS.md
세 가지 새로운 개발 규칙 추가: 터치 대상 크기 및 contentDescription 처리(UI), ktlint import 순서 준수, 매퍼 로직 위치 제한(ViewModel/UseCase 금지)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

Suggested reviewers

  • TTRR1007
  • JaeYoung290
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed PR 제목이 변경 사항의 핵심을 명확하게 반영하고 있습니다. AGENTS.md 파일에 코딩 규칙을 추가하는 것이 주요 변경 사항이며, 제목이 이를 정확히 설명하고 있습니다.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/1398-agents-md-rule

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@KYM-P KYM-P self-assigned this Mar 30, 2026
@sonarqubecloud
Copy link
Copy Markdown

@bcsd-b-bot bcsd-b-bot bot added the ci:passed label Mar 30, 2026
@kongwoojin
Copy link
Copy Markdown
Member

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 30, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

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: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@AGENTS.md`:
- Around line 156-158: The new "Import Order" rule conflicts with existing
module-specific import guidelines; update the Import Order section to state that
ktlint's order is the default but module-specific AGENTS.md import orders (e.g.,
for data/, core/webapp/, core/navigation/, feature/store/, feature/article/) may
override it, and explicitly add an exception to exclude the callvan module from
import-order enforcement in reviews as requested by JaeYoung290; reference the
"Import Order" heading and the module-specific guidelines so readers know which
sections govern precedence and mention that reviewers should not flag
import-order violations for modules with their own rules.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: e3a73fd0-16ff-4898-a175-18a798676263

📥 Commits

Reviewing files that changed from the base of the PR and between ca522f1 and 46c31c1.

📒 Files selected for processing (1)
  • AGENTS.md

Comment on lines +156 to +158
### Import Order

- Import ordering **MUST** follow the order enforced by ktlint. Do NOT manually reorder imports.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

기존 import 순서 가이드라인(185-190줄)과 충돌합니다.

이 새로운 규칙은 Lines 185-190의 기존 가이드라인과 모순됩니다:

새 규칙 (156-158줄):

  • Import 순서는 ktlint가 강제하는 순서를 따라야 함
  • 수동으로 재정렬 금지

기존 규칙 (185-190줄):

  • 모듈별 AGENTS.md가 import 순서를 정의하면 그것을 따름
  • 모듈별 가이드가 없으면 Android Studio 기본 순서 유지
  • 저장소가 단일 전역 import 순서를 강제하지 않음

학습된 내역에서도 여러 모듈이 서로 다른 import 순서 요구사항을 가지고 있음을 확인할 수 있습니다(data/, core/webapp/, core/navigation/, feature/store/, feature/article/ 등).

두 섹션을 조화시키거나, 새 규칙이 모듈별 예외를 명시적으로 인정하도록 수정하는 것을 권장합니다.

Based on learnings: Multiple learnings show different modules have different import order requirements (data/, core/webapp/, core/navigation/, feature/store/, feature/article/), and JaeYoung290 requested to exclude import ordering violations from review in the callvan module.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@AGENTS.md` around lines 156 - 158, The new "Import Order" rule conflicts with
existing module-specific import guidelines; update the Import Order section to
state that ktlint's order is the default but module-specific AGENTS.md import
orders (e.g., for data/, core/webapp/, core/navigation/, feature/store/,
feature/article/) may override it, and explicitly add an exception to exclude
the callvan module from import-order enforcement in reviews as requested by
JaeYoung290; reference the "Import Order" heading and the module-specific
guidelines so readers know which sections govern precedence and mention that
reviewers should not flag import-order violations for modules with their own
rules.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants