Skip to content

[CUBRIDMAN-343] Greptile 자동 리뷰용 매뉴얼 표기 표준 도입 - #769

Open
bagus-kim wants to merge 5 commits into
CUBRID:developfrom
bagus-kim:CUBRIDMAN-greptile
Open

[CUBRIDMAN-343] Greptile 자동 리뷰용 매뉴얼 표기 표준 도입#769
bagus-kim wants to merge 5 commits into
CUBRID:developfrom
bagus-kim:CUBRIDMAN-greptile

Conversation

@bagus-kim

@bagus-kim bagus-kim commented Sep 2, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

매뉴얼 표기 표준을 문서화하고 Greptile 리뷰 봇이 PR에서 이를 근거로 자동 검토하도록 설정을 추가한다. tool-manuals 저장소에 적용된 표준과 표기 항목(한국어 33개, 영문 34개, 문자 인코딩 기준)을 동일하게 유지하고,이 저장소의 ko/en 번역 쌍 구조에 맞춰 적용 범위만 조정했습니다.

추가 파일

  • docs/STYLE_GUIDE.ko.md 표기 표준 정본
  • .greptile/ 공통 규칙 8개 + 제외 대상 + 리뷰 근거 파일 지정
  • ko/.greptile/ 한국어 매뉴얼 전용 규칙 6개
  • en/.greptile/ 영문 매뉴얼 전용 규칙 5개

이 저장소 구조에 맞춘 조정

  • 적용 범위를 ko/en 언어별로 분리했다. 한국어 표기 규칙 3개 (ko-notation-auto, ko-notation-manual, ko-honorific-consistency)는 en/에서 disabledRules로 비활성화해 오탐을 차단한다.
  • 제외 대상에 SQL 문법 정의(BNF), 예약어, 데이터 타입명, 함수명, 콜레이션 이름, 시스템 파라미터, 유틸리티 옵션, API 시그니처, 오류 메시지 카탈로그, 릴리스 노트 이슈 번호를 추가했다.
  • 콜레이션 이름(utf8_bin 등)은 SQL 식별자이므로 인코딩 표기 규칙의 대상이 아님을 명시했다.
  • ko/en이 번역 쌍이므로 기술 사양 변경 시 반대쪽 파일 동기화를 확인하는 규칙(ko-en-parallel-sync)을 추가했다.
  • .inc 파일(backup.inc, migration.inc, join_method.inc)을 .rst와 동일 기준으로 포함했다.

develop 기준 검출 현황(검출 건수와 수정 건수는 다름 — 상당수가 제외 대상)

  • ko 한국어 AUTO 1,676건 / en 영문 AUTO 356건
  • ko 안의 영문 AUTO 58건 / ko MANUAL 후보 497건
  • 기준 문체는 평서체(9,977건 대 경어체 762건)

Greptile은 PR에서 변경된 줄만 검토한다. 기존 문서의 전수 수정은 별도 표준화 작업으로 처리한다.

-- 현재 확인 중 & 수정 필요

@bagus-kim
[CUBRIDMAN-343] Greptile 자동 리뷰용 매뉴얼 표기 표준 도입
7a4002c 
매뉴얼 표기 표준을 문서화하고 Greptile 리뷰 봇이 PR에서 이를 근거로
자동 검토하도록 설정을 추가한다. tool-manuals 저장소에 적용된 표준과
표기 항목(한국어 33개, 영문 34개, 문자 인코딩 기준)을 동일하게 유지하고,
이 저장소의 ko/en 번역 쌍 구조에 맞춰 적용 범위만 조정했다.

추가 파일
- docs/STYLE_GUIDE.ko.md  표기 표준 정본
- .greptile/              공통 규칙 8개 + 제외 대상 + 리뷰 근거 파일 지정
- ko/.greptile/           한국어 매뉴얼 전용 규칙 6개
- en/.greptile/           영문 매뉴얼 전용 규칙 5개

이 저장소 구조에 맞춘 조정
- 적용 범위를 ko/en 언어별로 분리했다. 한국어 표기 규칙 3개
  (ko-notation-auto, ko-notation-manual, ko-honorific-consistency)는
  en/에서 disabledRules로 비활성화해 오탐을 차단한다.
- 제외 대상에 SQL 문법 정의(BNF), 예약어, 데이터 타입명, 함수명,
  콜레이션 이름, 시스템 파라미터, 유틸리티 옵션, API 시그니처,
  오류 메시지 카탈로그, 릴리스 노트 이슈 번호를 추가했다.
- 콜레이션 이름(utf8_bin 등)은 SQL 식별자이므로 인코딩 표기 규칙의
  대상이 아님을 명시했다.
- ko/en이 번역 쌍이므로 기술 사양 변경 시 반대쪽 파일 동기화를 확인하는
  규칙(ko-en-parallel-sync)을 추가했다.
- .inc 파일(backup.inc, migration.inc, join_method.inc)을 .rst와 동일
  기준으로 포함했다.

develop 기준 검출 현황(검출 건수와 수정 건수는 다름 — 상당수가 제외 대상)
- ko 한국어 AUTO 1,676건 / en 영문 AUTO 356건
- ko 안의 영문 AUTO 58건 / ko MANUAL 후보 497건
- 기준 문체는 평서체(9,977건 대 경어체 762건)

Greptile은 PR에서 변경된 줄만 검토한다. 기존 문서의 전수 수정은
별도 표준화 작업으로 처리한다.
@bagus-kim bagus-kim self-assigned this Sep 2, 2026
@greptile-apps

greptile-apps Bot commented Sep 2, 2026

Copy link
Copy Markdown

Reviews (1): Last reviewed commit: "[CUBRIDMAN-343] Greptile 자동 리뷰용 매뉴얼 표기 표..." | Re-trigger Greptile

greptile-apps[bot]
greptile-apps Bot reviewed Sep 2, 2026
View reviewed changes
Comment thread docs/STYLE_GUIDE.ko.md Outdated
@bagus-kim
[CUBRIDMAN-343] 셀프 체크 4단계의 CI 경고 처리 기준 정정
606ea71 
Greptile 리뷰 지적 반영. "경고가 0건이어야 합니다"가 CI에서 강제되는
것으로 읽힐 수 있었다. ko/Makefile과 en/Makefile의 SPHINXOPTS가 비어
있어 -W가 적용되지 않으므로, check.yml은 빌드 실패와 linkcheck의 깨진
외부 링크만 실패로 처리하고 Sphinx 경고는 통과한다.

- CI가 경고를 강제하지 않는다는 점과 그 이유(SPHINXOPTS 비어 있음)를 명시
- 기준을 "자신이 수정한 파일에서 새로 생긴 경고 0건"으로 한정
- 수정한 파일의 경고만 걸러 보는 grep 명령 추가
- 전체를 경고 없이 빌드하려면 SPHINXOPTS="-W --keep-going"을 직접 붙이도록 안내
- 워크플로 기본값에 -W를 넣는 작업은 기존 경고 정리 후 별도 PR로 분리
@bagus-kim
[CUBRIDMAN-343] -W 도입 관련 문장을 미결정 상태로 정정
504435d 
"별도 PR로 처리합니다"가 이미 분리된 PR이 있는 것으로 읽힐 수 있어
아직 결정되지 않은 사항임을 명시한다. 결정되면 12절 절차에 따라
Jira 이슈를 등록해 진행한다.
@bagus-kim
[CUBRIDMAN-343] .greptile를 Sphinx 빌드에서 제외
3ff302d 
CI 빌드 실패 수정. ko/.greptile/rules.md, en/.greptile/rules.md가 Sphinx
소스 트리 안에 있어 빌드가 실패했다.

  원본을 읽는 중… [1%] .greptile/rules
  sphinx.errors.SphinxError: markdown에 대한 소스 해석기가 등록되지 않았습니다
  make: *** [Makefile:50: html] Error 2

conf.py의 source_suffix가 '.md'를 markdown으로 선언하지만 myst_parser 등
마크다운 파서가 설치되어 있지 않고, exclude_patterns가 ['_build']뿐이어서
.greptile 아래의 .md 파일이 소스로 수집됐다.

ko/conf.py, en/conf.py의 exclude_patterns에 '.greptile'을 추가했다.
Sphinx 9.1.0(CI와 동일 버전)에서 해당 패턴이 디렉터리를 제외하는지 확인했다.
루트 .greptile/과 docs/는 소스 트리 밖이므로 영향이 없다.

docs/STYLE_GUIDE.ko.md 11절에 이 제외 항목을 지우면 빌드가 깨진다는 점과,
ko//en/ 아래에 .md를 새로 추가할 때 제외 여부를 확인하라는 안내를 추가했다.
kwonhoil
kwonhoil reviewed Sep 4, 2026
View reviewed changes
Comment thread .greptile/rules.md Outdated
@github-actions

github-actions Bot commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

✅ CUBRID Manual Preview is Ready!

All docs (KO/EN) are successfully built and deployed.

Type 🇰🇷 Korean (KO) 🇺🇸 English (EN)
🌐 Web View Docs View Docs
📄 PDF Download Download

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@greptile-apps greptile-apps[bot] greptile-apps[bot] left review comments
@hiclass hiclass hiclass approved these changes
@manyoung-jeong manyoung-jeong manyoung-jeong approved these changes
@kwonhoil kwonhoil kwonhoil approved these changes
@mhoh3963 mhoh3963 Awaiting requested review from mhoh3963 mhoh3963 is a code owner
@junsklee junsklee Awaiting requested review from junsklee junsklee is a code owner
@kavin0718 kavin0718 Awaiting requested review from kavin0718 kavin0718 is a code owner

Assignees

@bagus-kim bagus-kim

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@bagus-kim @hiclass @manyoung-jeong @kwonhoil