Pull Request 방법

MAA 통합 설명서

 사전 지식


MAA의 오류를 수정하려고 했을 때, 정보를 찾아도 잘 나오지 않아 어려움을 겪었습니다
그래서 이와 같은 상황을 다른 사람들이 반복하지 않도록 하기 위해 정보를 공유하는 목적으로 작성한 글입니다

본인이 수정한 오류 또는 문제를 MAA 정식 버전에 반영시키기 위한 과정에 대해 설명하고 있습니다!
vscode나 visual studio로 이용한 debug 및 pr 방법에 관한 것은 여기서 확인하세요

  • Repository 는 저장소라는 의미로 코드 및 기타 리소스 파일들을 저장하는 장소입니다
  • Fork 는 복사라는 의미로 말 그대로 원본 repo를 복사해 원본을 손상시키지 않으면서 수정을 하기위해 합니다
    기본적으로 원본 repofork해 복사본을 만들면 이를 개인 저장소라고 합니다
  • Pull Request 는 원본 repo에서 fork한 개인 저장소에서 작업한 내용들을
    원본 repo에 반영(병합)하기 위해 "요청"하는 것 입니다
  • Conflict 는 충돌이라는 의미로 말 그대로 동일한 내용에 대해 여러 사람이 다른 내용으로 PR을 해서 발생합니다
    단 이 충돌은 해결하기 어려울 수 있으므로, 이런 개념이 있다 정도로만 설명합니다


웹 기반으로만 설명을 합니다!
더 자세한 사항은 여기서 확인하세요


 웹 기반 Pull Request 방법


웹 기반으로 MAA에 Pull Request 하는 방법에 대한 설명

클릭 시 오픈


먼저 MAA 메인 repo로 이동하여 코드의 복사본을 fork합니다



Only dev branch 옵션을 체크하고, Create Fork를 클릭합니다



본인의 개인 저장소로 이동합니다. 제목은 "Your Name/MaaAssistantArknights"로 되어 있으며, 아래에  
"forked from MaaAssistantArknights/MaaAssistantArknights" 라는 작은 메모가 있습니다
이는 MAA 메인 저장소에서 복사한 것을 의미합니다



dev branch로 전환합니다




수정하려는 파일을 찾으려면 Go to file로 검색을 하거나, 위치를 알고 있다면 아래의 폴더를 탐색할 수 있습니다



파일을 열어 우측 상단의  ✏️ 아이콘을 눌러 편집을 시작합니다



편집 후 Commit Changes 를 누르면 개인 저장소에 변경사항을 반영할 수 있습니다



다음과 같이 작성을 하고 Commit message는 다음 규칙에 따라 접두사를 작성하는게 좋습니다!


  •  feat: - 새로운 기능 추가 (feature)
  •  fix: - 버그 수정 (bug fix)
  •  docs: - 문서 수정 (documentation)
  •  style: - 코드 형식, 정렬, 주석 등의 변경으로 코드 동작에 영향을 주지 않는 경우
  •  refactor: - 코드 리팩터링
  •  test: - 테스트 코드 추가 또는 수정
  •  chore: - 빌드 업무, 패키지 관리 등 자잘한 작업들


만약 실수를 했어도 걱정마세요! 다시 파일을 수정하고 다시 commit을 하면 됩니다!

수정을 다 했다면 이제 Pull Request를 할겁니다. 다음을 눌러서 최종적으로 변경사항들을 확인합니다




최종 확인을 하고 문제가 없다면 create Pull Request를 눌러주세요!



MAA 팀 전문가들의 리뷰를 기다리세요! 물론 그들은 몇가지 코멘트를 제공할 수 있습니다.

추가적인 변경 사항이 요청되면 개인 저장소로 돌아가 dev branch로 전환하고 다시 commit 을 하면됩니다!

전문가들이 승인하면 Pull Request는 위와 같이 닫히고, 변경사항은 병합됩니다

무한한 헌신에 감사합니다!


2024-01-27 02:00 최신화