CONTRIBUTING.md

Contributing to Githru

TODO: Add support수정 필요!

Develop Environment

• node -v v14.17.3
• vscode
• vscode plugin - eslint

Installation

1. 이 저장소를 Fork 한 후 로컬 기기에 clone 합니다.

2. VSCode를 사용한다면 아래 과정을 통해 custom TS setting을 활성화해야합니다.

   1. TypeScript 파일이 열러있는 상태로 ctrl(cmd) + shift + p를 입력합니다.
   2. "Select TypeScript Version"을 선택합니다.
   3. "Use Workspace Version"을 선택합니다.

3. 브랜치 생성:

   git checkout -b MY_BRANCH_NAME

4. 의존성 설치:

   # can skip if you already installed
   npm i -g yarn
   yarn install

5. 라이브러리 개발 서버 띄우기:

   yarn serve

6. 그 외 여러가지 명령어들을 사용해볼 수 있습니다.

   # 빌드
   yarn build
   
   # 테스트
   yarn test

7. demo README를 참고해 demo앱도 실행해보세요.

Debugging

1. root 폴더에서 build 합니다.

   yarn build:all
   

2. vscode 폴더로 이동합니다.

3. Run 탭에서 Start Debugging을 누르거나 F5를 눌러 디버깅으로 진입합니다.

4. palette를 띄어 Open Githru View를 입력합니다.

Commit message

커밋 메세지는 제목과 본문을 포함해야합니다.

제목은 해당 커밋에 대한 주요 내용을 간략하게 기록합니다. 형식은 https://www.conventionalcommits.org/en/v1.0.0/ 를 따릅니다.

• optional scope을 사용하며, engine, vscode, view 3가지 scope만을 사용합니다.
• ex) feat(view): Add File Icicle Tree view.

본문은 커밋에서 수정된 상세내역을 작성합니다. 생략 가능하며, 어떻게보단 무엇을, 왜 해결했는지 적어주시는 것이 좋습니다.

상황에 따라 연관된 이슈 트래킹 번호를 포함합니다.

Issue

• 각 이슈는 1개의 주제만 포함해야합니다.
• 문제상황이나 제안을 포함해주세요.
• 최대한 구체적이고 명확하게 작성해주세요. *필요에 따라 스크린샷도 첨부해주세요.

Pull request(PR)

main 브랜치에 PR을 열어주세요.

각 PR은 1개의 주제만 포함해야합니다. 1개의 주제는 여러 부분의 코드를 수정할 수도 있습니다. 예를 들어, 새로운 ga 연동 함수를 추가는 라이브러리 구현, demo에 예시 추가, 문서 내용 추가 등을 포함합니다.

PR의 제목 형식은 commit과 동일하게 맞추면 됩니다.

Coding Guidelines

vscode의 eslint 플러그인을 통해 미리 설정된 코드 컨벤션을 적용하고 검사해볼 수 있습니다.

Add yourself as a contributor

기여자 목록에 자신을 추가하려면 All Contributors 봇 설명서를 참고하세요 :)