AgentSkillsCN

project-contributing-structure

定义本市场项目 CONTRIBUTING.md 编写规范。在项目根目录下编写或修改 CONTRIBUTING.md 时，应严格遵循本指南。

SKILL.md
--- frontmatter
name: project-contributing-structure
description: 이 마켓플레이스 프로젝트에 대한 CONTRIBUTING.md 작성 규약을 정의합니다. 프로젝트 루트의 CONTRIBUTING.md 작성 또는 수정 시 이 지침을 따릅니다.
user-invocable: false

CONTRIBUTING.md 작성 규약

이 프로젝트는 여러 Claude Code 플러그인들을 포함하는 모노레포 형태의 마켓플레이스 레포지토리로, 프로젝트 루트의 CONTRIBUTING.md는 아래 구조와 규칙을 따릅니다.

필수 섹션 (순서 준수)

  1. •제목: 기여 가이드임을 명시
  2. •소개: 프로젝트에 기여하는 방법에 대한 간결한 안내
  3. •개발 환경 구성: 로컬에서 개발을 시작하기 위한 단계별 가이드
    • •사전 준비 (필수 도구)
    • •저장소 클론
    • •로컬 마켓플레이스 등록
    • •플러그인 설치 및 활성화
  4. •프로젝트 구조: 디렉토리 구조와 각 디렉토리의 역할 설명
  5. •플러그인 개발 가이드: 새 플러그인 생성 또는 기존 플러그인 수정 시 따를 규칙
    • •새 플러그인 생성 절차
    • •구성 요소별 개발 방법 (Skills, Hooks, Agents 등)
  6. •커밋 규약: 커밋 메시지 작성 규칙 (프로젝트에 commit-message 스킬이 있으면 해당 스킬 참조)
  7. •Issue 작성 가이드: GitHub Issue 템플릿 종류와 선택 기준
  8. •Pull Request 제출 절차: 브랜치 전략, PR 템플릿, 리뷰 프로세스
  9. •트러블슈팅: 개발 중 자주 발생하는 문제와 해결 방법
  10. •추가 참고 자료: 관련 문서 링크

추가 리소스

작성 규칙

  • •언어: 한국어로 작성
  • •ordered list는 각 항목마다 1.으로 시작하여 자동 번호 매김 활용
  • •코드 블록에는 반드시 언어 태그 명시 (bash, json 등)
  • •모든 명령어는 복사-붙여넣기로 바로 사용 가능하도록 작성
  • •"설치 방법" 섹션(README.md)과의 차이를 명확히 구분
    • •README.md의 "설치 방법": 외부 프로젝트에서 이 마켓플레이스의 플러그인을 사용하기 위한 가이드
    • •CONTRIBUTING.md의 "개발 환경 구성": 이 마켓플레이스 프로젝트 자체를 개발하기 위한 가이드

개발 환경 구성 작성 형식

"개발 환경 구성" 섹션은 다음 순서로 작성합니다:

  1. •사전 준비: 필수 도구 목록 (Claude Code CLI 등)
  2. •저장소 클론: git clone 명령어
  3. •로컬 마켓플레이스 등록: 클론한 로컬 경로를 마켓플레이스로 등록하는 명령어
  4. •플러그인 설치 및 활성화: 개별/전체 플러그인 설치 명령어와 settings.json 확인 방법

Issue 작성 가이드 작성 형식

"Issue 작성 가이드" 섹션은 다음 내용을 포함합니다:

  1. •템플릿 선택 안내: 프로젝트에서 제공하는 Issue 템플릿 목록과 각 템플릿의 용도를 테이블로 정리
  2. •작성 팁: 좋은 Issue를 작성하기 위한 간단한 안내 사항 (구체적 재현 단계, 환경 정보 포함 등)

실제 .github/ISSUE_TEMPLATE/ 디렉토리에 존재하는 템플릿 파일들을 확인하여 목록을 작성합니다. 템플릿이 없는 경우 이 섹션은 생략합니다.

Pull Request 제출 절차 작성 형식

"Pull Request 제출 절차" 섹션은 다음 순서로 작성합니다:

  1. •브랜치 전략: 브랜치 이름 규칙과 base 브랜치 안내
  2. •PR 작성: PR 템플릿 활용법 및 필수 입력 항목 안내
  3. •리뷰 프로세스: PR 제출 후 리뷰 및 머지 절차

실제 .github/PULL_REQUEST_TEMPLATE.md 파일의 존재 여부를 확인하여 내용을 작성합니다. 템플릿이 없는 경우 이 섹션은 생략합니다.

트러블슈팅 작성 형식

트러블슈팅 섹션은 <details>/<summary> 접기 형식으로 작성합니다. 각 항목은 증상을 <summary>에, 원인과 해결 방법을 접힌 본문에 배치합니다.

markdown
<details>
<summary>증상 설명</summary>

**원인:** 원인 설명

**해결 방법:**

해결 절차 또는 명령어

</details>

반드시 포함해야 하는 트러블슈팅 항목:

  • •플러그인 인식 실패: 로컬 마켓플레이스 미등록이 원인인 경우
  • •Skills/Agents/Hooks 미표시: 플러그인 미설치가 원인인 경우
  • •설치 후 미동작: settings.json에서 비활성화가 원인인 경우
  • •Hooks 미작동: 스크립트 실행 권한 부재가 원인인 경우
  • •파일 수정 후 미반영: Claude Code 내부 캐싱으로 인해 SKILL.md, agents, hooks 등 플러그인 구성 요소의 변경 사항이 반영되지 않는 경우. 세션 재시작(/exit 후 재실행) 또는 플러그인 재설치(/plugin install)를 해결 방법으로 안내