CONTRIBUTING 문서 생성기

CONTRIBUTING 문서 생성기 사용 가이드

오픈소스나 사내 저장소에 다른 사람이 기여하게 하려면 '어떻게 설치하고, 무엇을 테스트하고, 커밋은 어떻게 쓰는지'를 적은 CONTRIBUTING.md가 있어야 합니다. 이 생성기는 몇 가지 정보로 그 초안을 만들어 줍니다.

'설치·테스트 명령과 규칙' 칸에 적은 명령 중 test·lint·check가 든 명령은 '테스트' 절에, 나머지 명령은 '개발 환경 준비' 절에 넣고, 저장소 주소가 git 주소면 git clone 명령도 앞에 붙입니다. 'conventional commits'라고 적으면 feat:, fix: 같은 커밋 규칙 설명을 넣고, 명령이 아닌 다른 줄은 '참고' 절에 목록으로 담습니다.

PR 절차와 행동 강령 절은 기본 문구와 안내 주석으로 채워지므로 팀 규칙에 맞게 다듬으면 됩니다.

사용 방법

1. 1'프로젝트 이름'과 '저장소 주소'를 적습니다.
2. 2'설치·테스트 명령과 규칙 (한 줄에 하나)' 칸에 npm install, npm test, conventional commits 같은 내용을 줄바꿈이나 ;로 나눠 적습니다.
3. 3'실행'을 누른 뒤 결과를 '다운로드'해 저장소 루트의 CONTRIBUTING.md로 저장합니다.

프로젝트 이름: ToolBada
저장소 주소: https://github.com/example/toolbada
설치·테스트 명령과 규칙: npm install; npm test; conventional commits; 이슈 먼저 열기

# ToolBada에 기여하기

관심을 가져 주셔서 감사합니다. 이슈와 풀 리퀘스트는 https://github.com/example/toolbada에서 받습니다.

## 개발 환경 준비

```bash
git clone https://github.com/example/toolbada
npm install
```

## 테스트

```bash
npm test
```

## 커밋 메시지 규칙

[Conventional Commits](https://www.conventionalcommits.org/) 형식을 따릅니다.

- `feat:` 새 기능
- `fix:` 버그 수정
- `docs:` 문서
- `refactor:` 동작 변화 없는 코드 정리
- `test:` 테스트

## 풀 리퀘스트 절차

1. 저장소를 포크하고 작업 브랜치를 만듭니다.
2. 변경과 테스트를 커밋합니다.
3. 풀 리퀘스트를 열고 무엇을 왜 바꿨는지 설명합니다.

## 참고

- 이슈 먼저 열기

## 행동 강령

<!-- CODE_OF_CONDUCT.md 링크를 넣으세요 -->

이럴 때 쓰면 좋아요

• 오픈소스 저장소를 공개하며 기여 안내를 처음 쓸 때
• 사내 저장소의 기여 규칙을 문서로 남길 때
• 새 팀원이 개발 환경을 혼자 준비할 수 있게 할 때
• 커밋 메시지 규칙을 팀에 공유할 때

문제가 생겼을 때

활용 팁

• GitHub는 CONTRIBUTING.md를 저장소 루트, docs/, .github/ 중 한 곳에 두면 이슈·PR 화면에 자동으로 링크를 보여 줍니다.
• PR 템플릿과 이슈 템플릿도 함께 만들면 기여 절차가 일관되게 안내됩니다.

자주 묻는 질문