프로필

프로필 사진
Popomon
Frontend Developer
(2020/12 ~)

    카테고리

    포스트

    [Github 협업 템플릿] Github PR Template 만들기

    2021. 11. 24. 22:41

    꿈가게: To Do List - iOS

    꿈가게: To Do List - Android

    저는 지금까지 PR을 올리면서 이렇게 올려라!라고 지시를 받은 적이 없습니다. 부끄럽게도... 오픈소스에 기여해 본 적이 없다는 뜻이겠죠?

    그래서 이번에 잠시 일을 쉬면서 PR 템플릿 이라는 것을 찾아보기 시작했습니다. 실제 서비스를 운영하는 입장에서 어떠한 정보들이 중요할지 고민을 해서 저만의 템플릿 양식을 작성해 보았습니다.

    수정한 내용

    말 그대로 PR에서 수정한 내용을 요약하여 5줄 이내로 작성해 볼 수 있을 것 같습니다. 예를 들면, "로그인/회원가입 프로세스를 5단계에서 2단계로 변경하였습니다." 와 같은 내용이 들어갈 수 있을 것입니다.

    테스트 케이스

    어떠한 기능을 개발하면, 테스트 시나리오 문서에 따라서 테스트를 하게 됩니다. 그런데 이 문서에는 전체 기능에 대한 테스트 케이스가 전부 들어가 있기 때문에, 해당 기능에 해당하는 테스트 케이스만 요약하여 다음과 같이 테이블로 작성해 볼 수 있습니다.

    결과 화면

    어떻게 변경되었는지 쉽게 알아보기 위해서, 구현된 화면을 녹화해서 하단에 첨부해 줍니다. (recordit 추천)

    템플릿 샘플문서

    # 📑 수정한 내용
    
    한번에 여러개를 수정할 수 있도록 기능을 변경하였습니다.
    
    Fixes # (issue)
    
    # ✔️ 테스트 케이스
    
    기기 | 1 depth | 2 depth | 3 depth | 케이스 | 체크리스트 | 결과
    --- | --- | --- | --- |--- |--- |---
    android | 홈 | 회원가입 | 회원가입 화면 | 완료버튼 클릭 | 이메일 회원가입 정상적으로 동작 | ✔️
    ios | 홈 | 회원가입 | 회원가입 화면 | 완료버튼 클릭 | 이메일 회원가입 정상적으로 동작 | ✔️
    
    # 💻 결과 화면
    ![image](https://user-images.githubusercontent.com/88924462/143242837-549a8d03-be18-4db5-b74e-b228edb97344.png)