오픈소스 만들어보기 - ① 시작 전 준비

오픈소스를 만들어, 최종적으로는 npm을 통하여 배포까지 진행해보자.

실제로 오픈소스를 만드는 것도 좋지만, lodash라는 유명 오픈소스를 비슷하게 제작하여 배포할 것이다.

 

https://lodash.com/

Lodash

lodash는 자바스크립트에서 유틸리티 함수들을 모아놓은 라이브러리로 배열, 객체, 함수 등의 다양한 데이터를 쉽게 다룰 수 있도록 도와주는 함수들을 제공한다.

제공하는 함수 예시들은 다음과 같다.

import _ from "lodash";

_.chunk([1, 2, 3, 4, 5], 2); 
// => [[1, 2], [3, 4], [5]]

_.uniq([2, 1, 2]);
// => [2, 1]

_.flatten([[1], [2, [3]]]);
// => [1, 2, [3]]

_.get({ a: { b: 2 } }, 'a.b');
// => 2

_.merge({ a: 1 }, { a: 2, b: 3 });
// => { a: 2, b: 3 }

 

프로젝트 시작에 앞서 레포지토리를 생성해야 하는데, 오픈소스들은 대부분 Github Organization을 통하여 관리된다.

Lodash 또한 Lodash Utilities라는 Organization의 레포지토리로 존재한다.

 

Your organizations를 누른 뒤, 우측 상단에 있는 New organization 버튼을 누른다.

Free 칸에 있는 Create a free organization을 클릭한다.

이름, 이메일을 입력하고 My personal account를 체크한 뒤 Next 버튼을 클릭한다.

팀원을 초대할 수 있는데, 없는 경우 Skip this step을 클릭한다.

그러면 성공적으로 Organization이 생성될 것이다.

Repositories를 눌러 Organization의 새로운 레포지토리를 생성해준 뒤 오픈소스 제작을 시작하면 된다.

https://makeaccident.tistory.com/86

 

 

레포지토리 작업이 끝났다면 브랜치 보호 세팅을 진행해주어야 한다.

만약 다른 기여자가 이 레포지토리에서 엉망으로 작업하고 기존 브랜치를 망가뜨릴 수 있기 때문이다.

레포지토리에서 Settings - Branches를 누른 뒤 Add branch ruleset을 클릭한다.

 

ruleset 중 "Require a pull request before merging"을 체크하고 Required approvals를 1 이상으로 설정해준다.

위 옵션을 체크해주면 머지를 진행하기 전에 반드시 PR을 요구하여 무분별한 머지를 막아준다.

또한 Required approvals를 1 이상으로 체크하여 1명 이상이 체크해야 머지가 되도록 설정할 수 있다.