글을 시작하며
프로젝트를 진행하면서 좋은 PR 메시지 작성에 대해 고민한 적이 많습니다.
특히 4pic 1인 프로젝트를 개발하면서 처음에는 조금 실험적인(ㅋㅋ🤣) 메시지들이 많았답니다. 다른 사람들의 PR 메시지를 참고하며 많이 배우고, 고민을 거듭했습니다. 그 과정에서 점차 제 입맛에 맞게 수정해 나갔습니다. 이제는 대체로 윤곽이 잡혀서 만족스럽습니다.
저와 같은 고민을 하는 다른 분들을 위해 저의 양식을 공유하고 싶어 글을 작성합니다.
PR 제목
양식
[#이슈번호][기능 또는 페이지 이름] 주요 작업 내용 요약
예시
[#25][Frame Page] CRUD Implementation, Membership Restriction, and Optimizations
[#42][Auth Module] JWT Authentication and Security Enhancements
구성 요소 설명
- [#이슈번호]: 해당 PR과 연관된 이슈 번호를 추가해 맥락을 명확히 합니다.
- [기능 또는 페이지 이름]: 작업이 이루어진 페이지나 주요 기능을 짧게 명시하여 작업 범위를 구체화합니다.
- 주요 작업 내용 요약: 작업의 핵심 내용(예: CRUD 구현, 성능 최적화, 접근 제한)을 간결하게 기재하여, 어떤 작업이 이루어졌는지 파악할 수 있게 합니다.
PR 내용
양식 - KR
🌱 브랜치:
[이름]/[날짜]➕ 관련 이슈
[관련된 이슈들을 나열하고 링크를 추가하여 맥락을 명확히 합니다.]
✅ 요약
- [이번 PR에서 구현한 주요 기능이나 변경 사항을 간략하게 설명합니다. 주로 핵심적인 개선 사항이나 수정 사항을 강조하세요.]
📋 상세 설명
- [기능명]: [구현한 기능에 대해 구체적으로 설명합니다. API, 라우팅, 백엔드 로직 등 변경 사항을 상세히 다루고, 외부 툴(예: Vercel Blob)을 사용한 경우 이를 언급하며 주요 개선 사항(예: 저장소 최적화, 로딩 속도 개선, API 구조 변경 등)을 강조합니다.]
📸 스크린샷 / 이미지
[변경 전후 이미지나 스크린샷을 제공하여 변경 사항을 시각적으로 확인할 수 있도록 합니다.]
⏭️ 리뷰 후 다음 단계
- [리뷰 후 필요한 후속 작업을 나열합니다. 예를 들어, 배포, 문서화, 홍보 등의 단계를 포함할 수 있습니다.]
양식 - eng
🌱 Branch: [name] / [date]
➕ Related Issues
[List relevant issues, linking to them for context.]
✅ Summary
- [Briefly describe the main changes or features implemented in this PR, focusing on high-level improvements or fixes.]
📋 Detailed Description
- [Feature Name]: [Describe the specific feature, including changes in API, routing, or backend logic. Mention any external tools or services integrated, such as Vercel Blob, and highlight key improvements (e.g., enhanced storage, faster load times, or API restructuring).]
📸 Screenshots / Images
[Optional: Provide before/after images or screenshots if relevant, especially if they visually demonstrate the changes or improvements made.]
⏭️ Next Steps After Review
- [List any remaining actions, such as deployment, documentation updates, or promotion steps.]
예시
🌱 브랜치:
feature/42-authentication/2024.11.09➕ 관련 이슈
[#42 회원 인증 기능 구현]
✅ 요약
- JWT(JSON Web Token) 인증 방식을 사용하여 회원 인증 기능을 구현했습니다.
회원 가입, 로그인, 인증 상태 유지 기능을 추가했습니다.- 회원 인증 전용 API를 통해 안전하게 사용자 정보를 처리합니다.
📋 상세 설명
- 회원 가입 및 로그인: 회원 가입 시 비밀번호 암호화를 추가하고, 로그인 시 JWT를 발급하여 인증을 처리합니다. 발급된 토큰은 클라이언트에서 로컬 스토리지에 저장되어 인증 상태를 유지합니다.
- 회원 인증 API: api/auth/register, api/auth/login 경로로 회원 가입과 로그인 기능을 처리하는 API를 구현했습니다.
보안 강화: 비밀번호 암호화를 위해 bcrypt 라이브러리를 사용하였고, JWT 토큰을 통해 세션을 관리하여 보안을 강화했습니다.- 토큰 검증 최적화: 서버에서 JWT 토큰을 검증하는 과정을 최적화하여 로그인 및 인증 과정에서의 지연을 최소화했습니다.
📸 스크린샷 / 이미지
⏭️ 리뷰 후 다음 단계
- 배포 준비
- 문서화 작업: API와 JWT 인증 흐름 문서화
추가적인 회원 관리 기능 개발 (예: 비밀번호 찾기, 이메일 인증)
글을 마무리하며
모든 개발자들이 바라듯 항상 좋은 PR 메시지를 작성하고 싶었습니다. 처음에는 엉망진창이었던 메시지들이 여러 차례 시도와 개선을 거듭하면서 저만의 스타일을 확립하게 되어 매우 뿌듯합니다. 이 양식이 다른 분들에게도 유용하게 사용될 수 있다면 더할 나위 없이 기쁠 것 같습니다. 😉
혹시 더 개선할 점이 있다면 언제든지 도움이 될 만한 조언을 주시면 감사하겠습니다. 🙇
(난리났었구만..)
