Skip to content

인프런 워밍업 스터디 미니프로젝트 코드 리뷰를 위한 저장소

Notifications You must be signed in to change notification settings

jo-kim/warming-up-study-mini

 
 

Repository files navigation

인프런 워밍업 스터디 미니 프로젝트 저장소

  • 스터디 진행 인원 중 원하는 스터디원이 모여 서로의 코드를 리뷰하기 위한 저장소.

방식

저장소 관리

  1. 공통 Repository 생성 후 Fork 후 작업
  2. 공통 Repository 에서 Fork 없이 작업

PR 방식

  1. 공통 Repository 에 각자 Directory 를 만든다.
  2. 각자 Directory 에 미니프로젝트를 위한 스프링 프로젝트를 생성한다.
  3. 단계별 미니 프로젝트 코드를 작성한다.
  4. 단계별 코드 작업이 끝나면, 공통 Repository 의 Main 브랜치에 PR을 보낸다.
    • PR 을 보낸때 해당 PR 에 맞는 Label 등록
    • 담당자와 리뷰어 등록 확인
  5. 리뷰를 확인한다.
  6. 리뷰가 끝났으면, PR 을 반영한다.
  7. 반영된 내용을 개별 Repository 에 반영 후 새로운 작업을 진행.
  8. 3~7 반복

리뷰 방식

  1. 올라온 PR 확인
  2. PR 에 대한 리뷰 작성
  3. 모든 리뷰 작성 후,

리뷰

  • 각각의 Reviewer 는 하나의 PR 에 최소한 1개 이상의 리뷰를 달 수 있도록 노력하자.
  • 사소한 오탈자 부터, 작성된 코드에 대한 자신의 생각등등 자유롭게 리뷰를 작성하되, 근거를 확실하게 하자.
    • 잘못된 예: Lombok 은 사용하면 안됩니다.
    • 올바른 예: Lombok 은 사용할때는 매우 편리하지만 이미 IDE 에서 편리하게 코드를 만들어주는 기능이 있고, 특정 어노테이션을 사용할때 주의해야하는 점이 있어 저는 사용을 지양하고 있는데 어떻게 생각하시나요?

리뷰 진행 시간

  • 리뷰 남길 시간
    • 리뷰의 빠른 처리를 위해 리뷰를 처리할 기간을 정해두자.
    • 28일 PR -> 29일 자정 까지.

리뷰 반영

  • 리뷰에서 발생한 코드 수정 사항을 어떻게 처리할것인지.
    1. 바로 반영
    2. 다음 PR에 반영

PR 템블릿

## 🚀 작업 내용

-

## 💬 리뷰 중점사항

-

### 📌 PR 진행 시 이러한 점들을 참고해 주세요

- Reviewer 분들은 코드 리뷰 시 좋은 코드의 방향을 제시하되, 코드 수정을 강제하지 말아 주세요.
- Reviewer 분들은 좋은 코드를 발견한 경우, 칭찬과 격려를 아끼지 말아 주세요.
- Review 는 Reviewer 로 지정된 시점 기준으로 다음날 오전까지 진행해주세요.

About

인프런 워밍업 스터디 미니프로젝트 코드 리뷰를 위한 저장소

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Java 100.0%