DefinitelyTyped에 타입 정의 기여하기

안녕하세요! RyuWoong 입니다.

봄이 오기전 날씨가 변덕을 부리는지 폭풍우가 치는 일요일입니다.

오늘은 제가 차곡을 만들면서 사용한 Chart 라이브러리의 Pie Chart는 선언된 타입과 다르게 동작하거나, 빠진 Property가 존재 했습니다. 계속 이 라이브러리를 사용해야하기 때문에 수정해야겠다고 생각했습니다.

---

Fork 하고 Clone 하기.

가장 먼저 해야할 일은, 아래 링크 프로젝트를 Fork 하는 것 입니다.

GitHub - DefinitelyTyped/DefinitelyTyped: The repository for high quality TypeScript type definitions.

Fork하게 되면 나의 깃헙  Repository에 해당 프로젝트가 클론되어 생기게 되고, 이를 우리는 로컬로 Clone해줍시다.

 

해당 라이브러리 Types 수정하기.

Clone한 DefinitelyTyped 프로젝트 폴더에 들어가 npm install 해줍니다! 그리고 types폴더 내에서 수정할 라이브러리를 찾아 타입 파일을 수정해주세요. 그리고 test 파일도 함께 맞춰 수정할 것이 있으면 수정해주세요.

 

Test 하기.

터미널에서 아래와 같이 입력하여 Test할 수 있습니다.

npm test 라이브러리명

 

 

그후 테스트 결과를 확인해주세요. test에 별이상 없다면, 이제 Commit을 해주면 됩니다.

Commit Message에 별도 양식은 없지만, 아래와 같은 요청사항이 있으니 깔끔하게 적어주세요.

Use a meaningful title for the pull request. Include the name of the package modified.

Pull Request 하기.

Commit, Push를 완료하면, Fork한 Repository로 들어가 Pull Requests 메뉴를 선택하세요.

그리고 새로운 Pull Request를 만들어 주세요. 그러면 아래와 같이 나의 변경점을 원본에 Merge요청할 수 있습니다.

Pull Request를 요청하면, Bot이 진행사항을 알려주고 conflict 되는 등의 문제가 발생하지 않는다면, 아래처럼 깔끔하게 통과가 됩니다.

통과가 된다면, 24시간 안에 npm에 반영된다고 하네요 : )