Skip to content

Latest commit

 

History

History
65 lines (42 loc) · 1.47 KB

File metadata and controls

65 lines (42 loc) · 1.47 KB

기여 가이드

이 프로젝트에 기여해주셔서 감사합니다. 아래 가이드를 읽고 참여해주세요.

기여할 수 있는 것들

  • 새로운 AI 활용 팁 문서 작성
  • 기존 문서에 예시나 팁 추가
  • 오탈자, 부정확한 내용 수정
  • 더 나은 예시로 교체

문서 작성 규칙

파일

  • 문서는 docs/ 디렉토리에 위치
  • 파일명은 케밥 케이스 (예: getting-accurate-answers.md)
  • 새 문서 추가 시 README.md 목차에 링크도 함께 추가

문체

  • 한국어로 작성
  • 간결한 서술체 사용 (~다, ~하라)
  • 경어체(~합니다, ~하세요) 사용하지 않음

내용

  • 이론보다 실전 팁 위주
  • 구체적인 예시를 반드시 포함 (나쁜 예 vs 좋은 예 형태 권장)
  • 특정 도구에 종속되지 않는 범용적인 내용 지향

문서 구조 참고

기존 문서들은 대체로 아래 흐름을 따른다. 반드시 동일할 필요는 없지만 참고하면 좋다.

# 제목
도입부 (이 문서가 왜 필요한지 1-2줄)

---

## 1. 소제목
설명 + 예시

---

## 2. 소제목
설명 + 예시

...

## 요약
핵심 내용을 테이블로 정리

기여 절차

  1. 이 저장소를 fork한다
  2. 브랜치를 만든다 (git checkout -b docs/주제-이름)
  3. 문서를 작성하고, README 목차를 업데이트한다
  4. PR을 보낸다

질문이나 제안

새로운 주제를 제안하거나 질문이 있으면 Issue를 열어주세요.