본문 바로가기
프로젝트/Short Term

[short-term] prisma/prisma-example 기여하기

by TLOWAC 2024. 11. 15.

 

🏃🏻 들어가며

이번 글에서 prisma/prisma-example 프로젝트에 기여한 과정에 대해서 정리해 보았습니다.

 

 

prisma-example 프로젝트에서 prisma 예시를 살펴 보는 과정에서 unused import 를 발견하게 되었고, 이를 기반으로 코드를 수정하는 issue 와 pr 을 만들었습니다. 처음에는 반응이 없어 필요치 않은 작업을 한것인가 라는 생각이 들었었는데, 어느날 github profile 에 prisma 로고가 떠있길래 확인해보았더니 운이 좋게도 PR 이 정상적으로 merged 된것을 확인 할 수 있었습니다 :)

 

 

특정 프로젝트에 Contribute 할때의 방식은 아래와 같이 정리할 수 있습니다.

 

1. 기여할 내용을 찾는다.

2. 해당 내용을 어떻게 수정할지 정리하여 issue 를 남긴다.

3. 해당 내용을 수정한 Pull Request 를 만든다.

4. Reviewer 의 답변을 기다린다.

5. Merge 또는 Reviewer 의 요청 사항을 반영한다.

 


 

  Issue & Pull Request 만들기

1) Contribute 하고자 하는 내용을 issue 로 정리하기

issue 에서는 내가 어느 부분의 코드를 어떻게 수정할것인지 대략적인 설명을 작성하였습니다. 

prisma 예제에서  import { INestApplication } from '@nestjs/common'  코드는 더 이상 사용되지 않기에 해당 코드를 제거하기 위해 실제 예제 코드와 수정할 부분의 코드를 하이라이트하여 설명을 작성하였습니다.

 

해당 issue 는 추후에 PR 에서 history 를 파악하기 위해 링크로 첨부될 예정 입니다.



 

2) PR 제작 하기

PR 에서는 AS-IS (수정전) / TO-BE (수정후) 코드 모습을 통해 Reviewer 가 한눈에 수정 사항을 파악 할 수 있도록 설명을 작성하였습니다.

 

추가로, 왜 해당 PR 을 만들게 되었는지 history 내역을 알려주기 위해서 사전에 만들어 놓았던 issue 의 링크또한 첨부하였습니다.


 

 

📍마무리하며

운이 좋게도 매번 사용하는 prisma-orm 의 Contributer 가 될 수 있었습니다.

자칫 어렵게만 느껴졌던 Contribute 도 이제는 한결 편안하게 다가오는것 같습니다.

 

반응형

댓글