jiwon-o/CodeReview

Code Review

멋쟁이사자처럼 프론트엔드 5기 7조 🎰77l리77ㅣ리🎰의 코드리뷰 GitHub입니다.
서로 코드리뷰를 통해 다른 사람은 어떻게 코드를 작성했는지, 다른 사람의 코드가 어떻게 하면 더 좋을 것 같은지, 여기에 왜 이렇게 사용을 했는지 등등을 알아보고 공부하는 용도입니다.

💡 리뷰하기 위해 알아야 할 것

해당 repository를 Fork 합니다. (Owner가 개인 계정으로 되어 있어야 합니다)
- fork된 repo를 local에 clone해 사용합니다.
해당 repository에 브랜치를 생성합니다.
- 브랜치 이름은 각자의 이름을 소문자로 띄어쓰기나 특별문자 없이 작성합니다. (ex. hyeri)
생성된 브랜치에 브랜치 이름과 같이 각자의 이름을 폴더로 생성합니다.
생성된 폴더 안에 Commit 메시지 형식을 지켜 Commit 합니다.
- 이때 필요없는 파일이 추가되지 않도록 하세요.
원본 repository에 Pull Request를 합니다.
다른 사람들의 코드를 보고 규칙을 지켜 코드리뷰를 합니다.

자세한 방법은 다솜님이 작성해주신 Notion page를 참고해주세요: GitHub Organization 사용방법

✅ Commit 메시지 형식

[commit title] commit message
예시: git commit -m "[호두마켓] JS 구현"

✅ Pull Request 형식

[이름] title: description
예시: [혜리] 호두마켓: JS 구현 코드리뷰 요청

📌 코드 리뷰 규칙

코드 리뷰 요청할 때

변경한/코드 리뷰를 요청할 내용에 대한 충분한 정보를 제공하기
- 특정한 부분에 관해 코드 리뷰를 요청하고 싶다면 그에 관해 충분한 정보를 제공하세요.
Commit과 Pull Request 형식을 충실히 지켜서 작성하기
- 컨벤션에 대한 연습이라고 생각하고 충실하게 지켜주세요.
Pull Request를 한 후 Discord를 통해 알려주기
- Discord를 통해 다른 조원들도 코드 리뷰 요청에 관해 알려주세요. 더욱 원할한 코드 리뷰를 할 수 있습니다.

코드 리뷰할 때

왜 개선이 필요한지 이유를 충분한 설명해 주세요.
답을 알려주기보다는 스스로 고민하고 개선 방법을 선택할 수 있게 해주세요.
코드를 클린 하게 유지하고, 일관되게 구현하도록 안내해 주세요.
리뷰 과정이 숙제검사가 아닌 학습과정으로 느낄 수 있게 리뷰해 주세요.
리뷰를 위한 리뷰를 하지 마세요. 피드백 할 게 없으면 칭찬해 주세요.
작은 커밋 단위만을 보지 말고, 전체 코드의 맥락을 살피면서 리뷰를 해주세요.

자세한 코드 리뷰 팁은 아래 페이지를 참고해주세요: 효과적인 코드리뷰를 위한 리뷰어의 자세

그 외

코드 리뷰는 PR를 통해 합니다.
코드 리뷰를 마친 후 마음에 충분히 들었다면 확인 후 merge를 합니다.
아직 배우는 입장에서 쉽지 않겠지만 같이 학습한다는 생각으로 코드 리뷰를 진행해주세요.
텍스트는 딱딱하기에 읽는 사람이 오해할 수 있습니다. 부드러운 언어로 리뷰해주세요.
더 디테일하고 코드 리뷰를 하고 싶거나 요청하고 싶으면 Discord을 권장합니다.

🎰 77l리77ㅣ리 팀원 소개

_{조장 : 우혜리}

_{조원 : 김율이}

_{조원 : 성재윤}

_{조원 : 오지원}

_{조원 : 임다솜}

_{조원 : 장예지}