Skip to content

[Koin Project][Chore] AGENTS.md PR 컨벤션 추가#1305

Open
TTRR1007 wants to merge 1 commit intodevelopfrom
chore/#1301-add-pr-title-convention
Open

[Koin Project][Chore] AGENTS.md PR 컨벤션 추가#1305
TTRR1007 wants to merge 1 commit intodevelopfrom
chore/#1301-add-pr-title-convention

Conversation

@TTRR1007
Copy link
Contributor

@TTRR1007 TTRR1007 commented Mar 5, 2026

PR 개요

이슈 번호: #1301

PR 체크리스트

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

작업사항

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

작업사항의 상세한 설명

AGENTS.md에 PR 컨벤션을 추가하였습니다

논의 사항

스크린샷

추가내용

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

Summary by CodeRabbit

  • Documentation
    • Added PR Title Convention guidelines with structured formatting requirements, including team/module labels, type labels, and practical examples for improved PR organization and consistency.

@TTRR1007 TTRR1007 self-assigned this Mar 5, 2026
@TTRR1007 TTRR1007 requested a review from a team as a code owner March 5, 2026 03:19
@coderabbitai
Copy link

coderabbitai bot commented Mar 5, 2026

📝 Walkthrough

Walkthrough

A new PR Title Convention section is added to AGENTS.md, providing structured guidance on formatting pull request titles with team/module and type labels, including practical examples for reference.

Changes

Cohort / File(s) Summary
Documentation Update
AGENTS.md
Added "PR Title Convention" section with formatting requirements, labeled examples, and guidance for PR title structure including team/module and type label conventions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A Title So Grand

PR titles dance in a structured way,
With labels and types on display,
Our AGENTS guide shines bright and clear,
Conventions now carved for all to hear,
Hop forward with standards sincere! 🎉

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title describes the main change: adding PR convention documentation to AGENTS.md. It is directly related to the changeset which adds a new PR Title Convention section to the file.

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

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/#1301-add-pr-title-convention

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.

@github-actions github-actions bot requested review from KYM-P and kongwoojin March 5, 2026 03:19
Copy link

@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 685-687: The two fenced code blocks in AGENTS.md (the template
block containing "[team/module][type] Subject" and the list block with PR
examples like "[campus][feature] Add bus schedule notification") are missing
language identifiers and trigger markdownlint MD040; update each opening
triple-backtick to include a language tag (e.g., use "text") so they become
```text, ensuring both the single-line template block and the multi-line example
block (also the similar block around lines 715-722) are modified accordingly.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 58c099da-94f3-4d98-acb5-a1652e167397

📥 Commits

Reviewing files that changed from the base of the PR and between 6aeab69 and 4febf66.

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

Comment on lines +685 to +687
```
[team/module][type] Subject
```
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Add language identifiers to fenced code blocks to satisfy markdownlint.

Both new fenced blocks omit a language tag (MD040), which will keep lint warnings active.

🔧 Proposed fix
-```
+```text
 [team/module][type] Subject

@@
- +text
[campus][feature] Add bus schedule notification
[campus][fix] Resolve crash on dining menu screen
[user][refactor] Extract common auth validation logic
[business][enhancement] Improve store detail loading performance
[koin project][chore] Update Gradle dependencies to latest versions
[koin project][documentation] Add PR title convention to AGENTS.md

Also applies to: 715-722

🧰 Tools
🪛 markdownlint-cli2 (0.21.0)

[warning] 685-685: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

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

In `@AGENTS.md` around lines 685 - 687, The two fenced code blocks in AGENTS.md
(the template block containing "[team/module][type] Subject" and the list block
with PR examples like "[campus][feature] Add bus schedule notification") are
missing language identifiers and trigger markdownlint MD040; update each opening
triple-backtick to include a language tag (e.g., use "text") so they become
```text, ensuring both the single-line template block and the multi-line example
block (also the similar block around lines 715-722) are modified accordingly.

Comment on lines +693 to +698
| Label | Description |
|-------|-------------|
| `campus` | BCSD campus (student) team |
| `user` | BCSD user team |
| `business` | BCSD business team |
| `koin project` | Project-wide or cross-module changes |
Copy link
Member

Choose a reason for hiding this comment

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

근데 이 라벨 이제 없애도 되지 않을까요 @KYM-P

| `feature` | New feature development |
| `fix` | Bug fixes |
| `refactor` | Code refactoring without behavior change |
| `enhancement` | Improvements to existing features |
Copy link
Member

Choose a reason for hiding this comment

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

enhancement는 없습니다

| `refactor` | Code refactoring without behavior change |
| `enhancement` | Improvements to existing features |
| `chore` | Minor changes and maintenance tasks |
| `documentation` | Documentation changes |
Copy link
Member

Choose a reason for hiding this comment

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

이것도 그냥 docs에요


### Type Labels

The second bracket identifies the type of work:
Copy link
Member

Choose a reason for hiding this comment

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

대문자로 시작해요

@TTRR1007 TTRR1007 changed the title [Koin Project][Chore] ASENTS.md PR 컨벤션 추가 [Koin Project][Chore] AGENTS.md PR 컨벤션 추가 Mar 5, 2026
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