[Docs] 추가된 컨벤션에 따른 리드미 수정 및 코드 리뷰 체크리스트 추가 #256
Conversation
WalkthroughThe pull request updates the README.md to provide a detailed, formalized coding convention and style guide for the iOS project, replacing previous fragmented notes. Additionally, the pull request template is revised to improve review guidance and add a comprehensive code review checklist. No code or exported entity changes are introduced. Changes
Assessment against linked issues
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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: 1
🧹 Nitpick comments (1)
README.md (1)
204-210: Consider enforcing the basic rules with SwiftLint / SwiftFormat
The section introduces max-line-length and indentation limits, but the repo will keep diverging unless the rules are machine-enforced. Adding a.swiftlint.yml/swiftformatconfig (or Xcode build-phase script) that reflects these numbers will prevent manual drift and reduce review noise.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.github/PULL_REQUEST_TEMPLATE.md(1 hunks)README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
254-254: Hard tabs
Column: 1
(MD010, no-hard-tabs)
🔇 Additional comments (1)
.github/PULL_REQUEST_TEMPLATE.md (1)
33-49: 👍 Comprehensive checklist aligns with new convention
The added items map 1-to-1 with the README rules and will help keep reviews focused. Nice touch including memory-leak & import-order points.
| `Setup` 관련 메서드는 다음 명명 규칙과 역할에 따라 구분하여 작성한다. | ||
| 아래 순서대로 차례대로 작성한다. | ||
|
|
||
| <div align="center"> | ||
|
|
||
| | 메서드명 | 역할 및 담당 업무 | | ||
| |---|---| | ||
| | `setupNavigationBar()` | 네비게이션 바 설정 및 구성 | | ||
| | `setupView()` | 해당 클래스의 프로퍼티 관리, 기본 뷰 설정 | | ||
| | `setupConstraints()` | addSubviews, SnapKit 등 오토레이아웃 관련 코드 | | ||
| | `setupAction()` | 액션 이벤트 관련 설정 | | ||
| | `setupDelegate()` | Delegate, DataSource 관련 코드 | | ||
| | `setupDataSource()` | 데이터 소스 초기화 및 설정 | | ||
| | `setupBinding()` | 데이터 바인딩 및 리액티브 프로그래밍 관련 코드 | | ||
|
|
There was a problem hiding this comment.
Replace hard tabs with spaces to satisfy markdown-lint (MD010)
Static analysis flags a tab character in this table. Tabs cause inconsistent rendering on GitHub and break the “no hard tabs” rule now encoded in CI.
- | 메서드명 | 역할 및 담당 업무 |
+| 메서드명 | 역할 및 담당 업무 |Run a quick sed -i '' $'s/\t/ /g' README.md (or your editor’s “convert to spaces”) before merge.
📝 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.
| `Setup` 관련 메서드는 다음 명명 규칙과 역할에 따라 구분하여 작성한다. | |
| 아래 순서대로 차례대로 작성한다. | |
| <div align="center"> | |
| | 메서드명 | 역할 및 담당 업무 | | |
| |---|---| | |
| | `setupNavigationBar()` | 네비게이션 바 설정 및 구성 | | |
| | `setupView()` | 해당 클래스의 프로퍼티 관리, 기본 뷰 설정 | | |
| | `setupConstraints()` | addSubviews, SnapKit 등 오토레이아웃 관련 코드 | | |
| | `setupAction()` | 액션 이벤트 관련 설정 | | |
| | `setupDelegate()` | Delegate, DataSource 관련 코드 | | |
| | `setupDataSource()` | 데이터 소스 초기화 및 설정 | | |
| | `setupBinding()` | 데이터 바인딩 및 리액티브 프로그래밍 관련 코드 | | |
| `Setup` 관련 메서드는 다음 명명 규칙과 역할에 따라 구분하여 작성한다. | |
| 아래 순서대로 차례대로 작성한다. | |
| <div align="center"> | |
| | 메서드명 | 역할 및 담당 업무 | | |
| |---|---| | |
| | `setupNavigationBar()` | 네비게이션 바 설정 및 구성 | | |
| | `setupView()` | 해당 클래스의 프로퍼티 관리, 기본 뷰 설정 | | |
| | `setupConstraints()` | addSubviews, SnapKit 등 오토레이아웃 관련 코드 | | |
| | `setupAction()` | 액션 이벤트 관련 설정 | | |
| | `setupDelegate()` | Delegate, DataSource 관련 코드 | | |
| | `setupDataSource()` | 데이터 소스 초기화 및 설정 | | |
| | `setupBinding()` | 데이터 바인딩 및 리액티브 프로그래밍 관련 코드 | |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
254-254: Hard tabs
Column: 1
(MD010, no-hard-tabs)
🤖 Prompt for AI Agents
In README.md around lines 250 to 264, replace all hard tab characters in the
markdown table with spaces to comply with markdown-lint rule MD010 and ensure
consistent rendering on GitHub. Use a command like `sed -i '' $'s/\t/ /g'
README.md` or your editor's convert-to-spaces feature to perform this
replacement before merging.
[Docs] 추가된 컨벤션에 따른 리드미 수정 및 코드 리뷰 체크리스트 추가
👻 PULL REQUEST
📄 작업 내용
🔗 연결된 이슈
Summary by CodeRabbit