Skip to content

teslamint/tidy-pilot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 

Repository files navigation

🧹 Tidy Pilot

PR이 futures를 넓히는지 좁히는지 판단하는 AI 코드 리뷰어.

Kent Beck의 Tidy First 철학에서 영감을 받아, Compounding Game을 시스템화합니다.

How It Works

ROADMAP.md + PR diff → LLM 분석 → PR 코멘트
  1. PR이 올라오면 GitHub Action이 트리거
  2. ROADMAP.md와 PR diff를 읽어 LLM에 전달
  3. LLM이 futures 영향을 분석하고 PR에 코멘트

Futures Impact Signals

🟢 Futures 확장 (좋음)

  • 결합도 감소
  • 새로운 추상화 도입
  • ROADMAP 항목을 더 쉽게 만드는 구조 변경

🔴 Futures 축소 (주의)

  • 결합도 증가
  • 하드코딩, 구체적 구현에 직접 의존
  • ROADMAP 항목을 어렵게 만드는 구조 변경

⚪ 중립

  • futures에 유의미한 영향 없음

Quick Start

1. ROADMAP.md 작성

프로젝트 루트에 로드맵을 작성하세요:

# Roadmap

## Next (1-2 weeks)
- [ ] 결제 시스템 연동 (Stripe)
- [ ] 사용자 알림 시스템

## Later (1-3 months)
- [ ] 멀티 테넌시 지원
- [ ] API rate limiting

2. GitHub Action 추가

.github/workflows/tidy-pilot.yml을 복사하고, repository secret에 OPENAI_API_KEY를 추가하세요.

3. Done!

PR이 올라올 때마다 futures 영향 분석 코멘트가 달립니다.

Configuration

환경변수 기본값 설명
ROADMAP_PATH ROADMAP.md 로드맵 파일 경로
MODEL gpt-4o-mini 사용할 LLM 모델
OPENAI_API_KEY - OpenAI API 키
COMMENT_ON_NEUTRAL false 중립 판정 시에도 코멘트

License

MIT

About

An AI code reviewer that determines whether PRs broaden or narrow futures.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors