스튜디오 규칙 (TinyCorn Studio 표준)
스튜디오의 모든 저장소/도구에 적용되며, 초기화부터 유지보수까지 사용됩니다.
언어
- 사용자와의 소통: 베트남어.
- 코드, 식별자, 커밋 메시지, 브랜치 이름: 영어.
- README, CHANGELOG, 릴리스 노트: 베트남어.
최소 저장소 구조
<repo>/
├── README.md # 필수
├── CHANGELOG.md # 필수 (Keep a Changelog)
├── LICENSE # 일반적으로 MIT
└── .gitignore # 필수
README.md에 포함되어야 하는 항목
- 소개 (1–2문장, 도구의 용도와 대상)
- 시스템 요구사항
- 빌드 / 실행
- 주요 기능 (그룹별)
- 단축키 (UI가 있는 경우)
- 아키텍처 / 디렉토리 구조
- 설정 (UserDefaults, 환경변수, 설정 파일 등)
- 알려진 제한사항
- 버전 기록 (요약, 자세한 내용은 CHANGELOG)
- 다운로드 (최신 GitHub Releases 링크 — 설치 파일을 저장소에 보관하지 않음)
Git
- 최소
.gitignore:.build/,dist/,node_modules/,.DS_Store, 빌드 시 자동 생성되는 리소스 디렉토리. - 커밋 금지: 설치 파일(DMG/ZIP), 빌드 출력물, 시크릿/토큰.
- 커밋 메시지: 한 줄, 명령형, 영어, 기능/수정 사항을 완전히 설명. 예:
Add folder view to Changes tab. - 완료된 기능 단위로 커밋; 사용자가 요청하거나 기능 완료를 확인한 후에만 커밋.
- 브랜치:
main은 항상 릴리스 가능한 상태 유지; 기능은 별도 브랜치에서 작업, 완료 후--ff-only로 병합. - 버전: SemVer, 한 곳에서만 선언 (예:
make-app.sh의VERSION), 여러 파일에 분산되지 않음.
문서
- README + CHANGELOG는 기능과 동시에 업데이트 (나중에 하지 않음).
- 모든 릴리스: annotated 태그
vX.Y.Z+ 베트남어 릴리스 노트가 포함된 GitHub Release (release-flow스킬 참조). - 복잡한 설계 결정은 코드 내 또는 README의 "아키텍처" 섹션에 바로 기록.
품질
- 완료 보고 전: 빌드/테스트 재실행, 실제 데이터 또는 샌드박스로 검증.
- UI: 적용 전 미리보기 (
ui-preview-first스킬 참조). - 사용자의 실제 데이터에 쓰기/커밋 테스트 금지 — 샌드박스 복사본 사용.
- 테스트 완료 후 샌드박스/임시 파일 정리, 저장소에 쓰레기 남기지 않음.
새 저장소 체크리스트
-
git init+ 표준.gitignore - 위 구조에 맞는 README
-
[0.1.0]섹션이 포함된 CHANGELOG - LICENSE (MIT)
- 빌드 스크립트 (make-app.sh 또는 동등) + DMG/설치 프로그램
- GitHub 원격 저장소 +
main푸시 - 설치 파일이 포함된 첫 번째 릴리스
- 이후 릴리스에 사용할
release-flow스킬 숙지