오픈소스 문서 기여 실습: GitHub 문서 템플릿 & 모던 자바스크립트 튜토리얼
📘 개요
이 실습에서는 GitHub에서 사용하는 문서 템플릿을 작성하고, 모던 자바스크립트 튜토리얼에 기여하는 방법을 학습합니다. 오픈소스 기여 경험을 통해 협업과 문서화의 중요성을 이해하는 것이 목표입니다.
🛠 실습 목표
- GitHub 저장소에 문서 템플릿 추가
- 모던 JavaScript 튜토리얼 한국어 페이지 수정
- Pull Request(PR) 생성 및 제출
- 오픈소스 커뮤니티 기여 경험
📂 1. GitHub 문서 템플릿 실습
✅ 작성할 템플릿 파일 종류
| 파일명 | 설명 |
|---|---|
README.md | 프로젝트 소개 문서 |
CONTRIBUTING.md | 기여 가이드라인 |
ISSUE_TEMPLATE.md | 이슈 작성 템플릿 |
PULL_REQUEST_TEMPLATE.md | PR 제출 템플릿 |
📝 예시: CONTRIBUTING.md
# Contributing Guidelines
Thanks for your interest in contributing! Please follow these steps:
1. Fork the repository
2. Create a new branch (`git checkout -b feature-xyz`)
3. Commit your changes (`git commit -m "Add feature xyz"`)
4. Push to the branch (`git push origin feature-xyz`)
5. Create a Pull Request📘 2. 모던 자바스크립트 튜토리얼 기여 실습
🌐 사이트 소개
- 주소: https://ko.javascript.info/
- 영어 원문 기반의 한국어 번역 오픈소스 프로젝트
- GitHub 저장소: https://github.com/javascript-tutorial/ko.javascript.info
🔧 기여 절차
- 저장소 포크 및 클론
git clone https://github.com/사용자명/ko.javascript.info.git
cd ko.javascript.info-
수정할 문서 찾기
- 예:
1-js/02-first-steps/01-hello-world/article.md
- 예:
-
문서 수정 (VSCode 등 에디터 사용)
-
수정 사항 커밋 & 푸시
git checkout -b fix-typo-hello-world
git commit -am "Fix typo in hello-world article"
git push origin fix-typo-hello-world- Pull Request 제출
- 깃허브 저장소에서
New Pull Request클릭
- 깃허브 저장소에서
✅ 기여 시 주의사항
- 번역 시 자연스럽고 정확한 한국어 사용
- 기술 용어는 통일성 있게 사용
- 변경 내용은 명확하게 커밋 메시지에 작성
- 커뮤니티의 리뷰를 기다리고 피드백을 반영
📎 참고 링크
🎉 실습 결과 예시
✅
ko.javascript.info저장소에 오탈자 수정 PR 제출 완료
✅CONTRIBUTING.md,PULL_REQUEST_TEMPLATE.md파일을 포함한 문서 템플릿 구성 완료
cs 21