Skip to content

branch 비교와 AI 코드 처리 정책을 README에 문서화한다 #52

Description

@opficdev

배경

branch 선별, 전수 비교, AI 코드 전송, report 전달 정책이 변경되면 consumer가 검사 범위와 코드 처리 방식을 설치 전에 이해할 수 있어야 함.

특히 Watcher가 읽기 전용이어도 conflict 코드 일부가 OpenAI API로 전송되는 점을 명시해야 함.

작업 범위

  • 활성 branch를 committer date 기준 14일 이내로 제한하는 정책 설명
  • 감시 branch 최대 30개와 초과 branch 제외 정책 설명
  • 새로운 workflow input을 추가하지 않는 고정 정책 설명
  • baseBranch와 활성 branch를 포함한 충돌 그래프 설명
  • 최대 465개 branch 관계 비교 설명
  • git merge-tree --stdin 기반 읽기 전용 merge 검사 설명
  • confirmed conflict와 potential overlap 구분 설명
  • conflict 코드 일부가 OpenAI API로 전송됨을 명시
  • AI 수정안이 자동 적용되지 않음을 명시
  • Discord 분할 전송과 GitHub Actions summary 설명
  • report 예시와 troubleshooting 갱신

제외 범위

  • TypeScript 구현
  • workflow input 추가
  • 자동 conflict 해결 기능
  • commit, push, PR 수정 기능

완료 기준

  • README만 보고 branch 검사 범위와 제한을 이해할 수 있음
  • OpenAI로 전송되는 코드 범위와 목적을 이해할 수 있음
  • Watcher가 repository를 변경하지 않는다는 점이 명확함
  • Discord와 Actions summary에서 결과를 찾는 방법을 확인할 수 있음

검증

  • README와 실제 상수 및 동작 대조
  • consumer workflow 예시와 secret 이름 대조
  • report 예시와 formatter 출력 대조
  • 링크와 명령어 검토

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions