CHECKLIST.md

예제 추가 체크리스트

새 예제를 추가하거나 기존 예제를 수정할 때 아래 항목을 점검하세요. 이 핸드북의 목표는 "입문자가 혼자 읽어도 이해되는 것" 입니다. 모든 항목은 그 기준으로 판단합니다.

1. 위치와 명명

• 올바른 디렉토리에 두었는가? (공식 기반 → tutorials/basic/, 커뮤니티 → tutorials/community/)
• 디렉토리 이름이 명명 규칙을 따르는가? (basic-NN-제목, 번호는 두 자리 0-패딩)

2. 코드

• 코드가 실제로 빌드되고 실행되는가? (의사코드 금지)
• GStreamer 1.x API만 사용했는가?
• C는 공식 튜토리얼 스타일, Python은 PyGObject(gi.repository.Gst)를 따랐는가?
• 주석이 "무엇"보다 "왜"를 설명하는가?

3. 설명 문서 (README.md)

• 권장 구조를 따르는가? (한 줄 요약 / 배경 지식 / 전체 코드 / 한 줄씩 뜯어보기 / 실행 방법 / 트러블슈팅 / 더 나아가기)
• 처음 등장하는 용어를 모두 풀어서 설명했는가? (pad, caps, bin, element, pipeline, bus 등)
• 비유나 그림말로 직관을 도왔는가?
• 실행 명령과 기대 출력을 적었는가? (복붙으로 따라할 수 있게)
• 초심자가 흔히 만나는 에러와 해결책을 적었는가?
• "더 나아가기"에 다음 예제 / 관련 공식 문서 링크를 넣었는가?

4. 출처와 라이선스

• 예제 README가 저장소 라이선스(CC BY-SA 4.0)와 충돌하지 않는가?
• 공식 기반 예제는 README 하단에 원본 링크를 남겼는가?
• 커뮤니티 독자 예제는 "GStreamer101 커뮤니티 독자 작성"임을 명시했는가?
• 공식 코드를 그대로 복제하지 않고 학습용으로 재구성했는가?

5. 실행 검증

• 예제를 직접 실행해 보았는가?
• 실행 결과(출력)를 README에 반영했는가?

6. 마무리

• 구조를 변경했다면 AGENTS.md의 디렉토리 섹션을 갱신했는가?
• 목차/README가 있다면 새 예제를 추가했는가?
• 커밋 메시지가 무엇을 추가/수정했는지 명확한가?