Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TTRR1007 wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
43 changes: 43 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -678,6 +678,49 @@ This commit fixes fabricated code examples that did not match
the actual implementation patterns in the codebase.
```

## PR Title Convention

PR titles **MUST** follow this format:

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

@coderabbitai coderabbitai bot Mar 5, 2026

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.


### Team/Module Labels

The first bracket identifies the responsible team or scope:

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

@kongwoojin kongwoojin Mar 5, 2026

Choose a reason for hiding this comment

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

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


### Type Labels

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

@kongwoojin kongwoojin Mar 5, 2026

Choose a reason for hiding this comment

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

대문자로 시작해요


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

@kongwoojin kongwoojin Mar 5, 2026

Choose a reason for hiding this comment

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

enhancement는 없습니다

| `chore` | Minor changes and maintenance tasks |
| `documentation` | Documentation changes |
Copy link
Member

@kongwoojin kongwoojin Mar 5, 2026

Choose a reason for hiding this comment

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

이것도 그냥 docs에요


### PR Title Examples

```
[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
```


## Required Configuration

Expand Down