PlanetScale에서는 새로운 기능이나 개선 사항 출시 시 변경 로그를 업데이트합니다. 각 변경 로그는 마크다운 파일로 Git 저장소에 관리되며, GitHub 풀 리퀘스트(PR)를 통해 병합 후 웹사이트에 게시됩니다. 이 과정은 일관된 형식과 문서화 후 작성되는 특징을 가집니다.
Cursor 명령의 이점
Cursor 명령은 이러한 변경 로그 생성에 이상적입니다. 기능 문서화 저장소에 이미 존재하는 컨텍스트를 활용하여, 특정 형식에 맞춰 변경 로그 초안을 자동으로 생성할 수 있습니다.
명령 생성 및 활용
Cursor 명령은 LLM이 최근 완료한 작업을 기반으로 초기 버전을 생성하도록 요청하여 쉽게 만들 수 있습니다. 예를 들어 API 문서 업데이트 후 /updateapi 명령을 생성하여 반복 가능한 워크플로우로 만듭니다.
-
점진적 개선: 초기 명령은 몇 번의 조정을 통해 신뢰할 수 있는 워크플로우로 발전할 수 있습니다.
-
편의성: Slack 봇을 통해서도 실행 가능하며, GitHub PR 자동 생성을 지원합니다.
변경 로그 명령 예시: “Create a changelog”
이 명령은 PlanetScale의 가이드라인에 따라 새로운 변경 로그 항목을 생성합니다.
- 파일 구조:
- 파일명:
kebab-case-title.md - 위치:
content/changelog/
- 파일명:
- 프런트매터:
title: ‘사람이 읽기 쉬운 제목’-
category: ‘Feature Enhancement Bug Fix’ (선택 사항) createdAt: ‘YYYY-MM-DD’
- 내용 가이드라인:
- 간결성: 1-3 단락, 전문 용어 피하고 대화체 사용.
- 일관성: 최근 변경 로그 참조.
- 특정 용어 금지: “programmatically” 사용 금지.
- 명확한 범위: Vitess/Postgres 전용 여부 명시.
- 추가 요소: 외부 링크, 스크린샷 포함.
- 일반적인 패턴:
- 변경 사항 및 이점 설명으로 시작.
**[자세히 보기](/docs/path)**형식으로 문서 링크 포함.- API/UI 기능에 맞는 링크나 스크린샷 추가.
- 여러 항목은 글머리 기호 사용.