프로그래머스 데브코스 88일차 with. TS 웹 풀스택

📚요약

지난 시간 오픈 소스에 대해 기여하는 방법과 MDN에 기여하는 방법을 살펴보며 실습을 해봤습니다. 이번 시간에는 github의 문서 템플릿 기능과 모던 자바스크립트 튜토리얼에 대해 기여해 보겠습니다.

 

📖오픈 소스

📄github 문서 템플릿

지난 시간 이슈나 PR을 작성할 때 서식을 정해두고 작성하면 좋다고 언급했습니다. 서식을 사용하면 여러 사용자들이 함께 할 때 큰 문제없이 문서의 일관성을 맞힐 수 있습니다. 이때 github에서 제공하는 github 템플릿 기능을 사용할 수 있습니다.

 

📑실습1

이슈와 pr에 대한 템플릿을 만들어 보겠습니다. 해당 실습은 Github 페이지에서 파일을 추가하는 것으로 쉽게 실습할 수 있습니다.

1. .github 폴더 만들기
2. 폴더 내부에 issue_template.md, pull_request_template.md 파일 생성하기

🍯tip! 템플릿에는 markdown 문법을 적용할 수 있기 때문에 다양하게 문서 서식을 작업할 수 있습니다.

 

📑실습2

개인 repo의 Setting 탭으로 들어가면 General 탭 > Features 속성에서 Issues를 체크하고 Set up templates를 통해 Github에서 제공하는 기능을 이용할 수 있습니다. 해당 기능을 이용하면 이슈의 종류마다 템플릿을 새로 만들 수 있습니다.

 

직접 만들어서 추가하고 싶은 경우

1. .github 폴더 밑에 ISSUE_TEMPLATE 폴더를 만든다
2. 원하는 이름으로 markdown 파일을 만든다
3. 파일 내부에 하단 텍스트를 포함시키고 실습1에서 진행했던 과정을 반복하면 됩니다.

---
name: <템플릿 이름>
about: <템플릿 설명>
title: ''
labels: ''
assignees: ''

---

<템플릿 작성>

△이름.md

위와 같이 작성하는 경우는 템플릿을 작성할 수 있지만 url로 이동하거나 설명을 해주는 템플릿도 작성할 수 있습니다.

1. .github 폴더 밑에 ISSUE_TEMPLATE 폴더를 만든다
2. 원하는 이름으로 yml 파일을 만든다
3. 내부에 원하는 내용을 작성한다

blank_issues_enabled: true
contact_links:
  - name: <이름>
    url: <url>
    about: <설명>
  - name: <이름>
    url: <url>
    about: <설명>

△이름.yml

 

📄모던 자바스크립트 튜토리얼

MDN 사이트는 웹에 대한 HTML, CSS, JAVASCRIPT 등 다양한 정보를 제공해 줍니다. 그와 다르게 모던 자바스크립트 튜토리얼은 자바스크립트의 기본부터 고급까지의 개념을 다루는 사이트입니다. 해당 사이트도 MDN처럼 기여 방법이 잘 정리되어 있고 번역과 같이 문서에 대해 기여할 수 있습니다.

 

자세한 내용은 사이트를 보시면 됩니다.

모던 JavaScript 튜토리얼

 

📑가이드라인 살펴보기

지난 시간 살펴봤던 MDN의 가이드라인과 비슷하게 상세한 내용이 나와있는 것을 확인할 수 있습니다.

 

자세한 내용은 사이트에서 확인할 수 있습니다.

ko.javascript.info/CONTRIBUTING.md at master · javascript-tutorial/ko.javascript.info

 

또한 아래 블로그를 참고하면 좋습니다.

모던 JavaScript 튜토리얼 프로젝트

 

📑로컬 환경 세팅

사이트를 참고하셔서 세팅할 수 있습니다.

로컬 서버 세팅하기

🍯tip! 실제로 PR을 진행하기 위해서는 먼저 권한을 요청받아야 한다.

 

📑로컬 환경 실행 에러

./edit ko 명령어 실행 시 오류 발생

 

다음 시간에 계속...

 

출처 & 참고

강사님의 강의