스터디 소개

프로그래머스 생성형 AI 백엔드 1기 Clean Code 스터디를 소개합니다 :)

📚 스터디 개요

✨ 스터디 소개

• Clean Code 책을 기반으로 수업에서 배운 실습 코드나 개인 프로젝트에 적용하며 클린 코드의 원칙과 중요성을 학습합니다.
• 수업 중 배운 실습 코드를 바탕으로 책 내용을 연계하여 자신만의 코드를 작성합니다.
• 각자 작성한 코드를 발표하고 서로의 코드를 비교하며 책에서 배운 내용을 어떻게 적용했는지 토론합니다.

📌 진행 일정 및 특이사항

• 주별 스터디 분량은 도서 수령 후 확정될 예정입니다.
• 책은 총 17장으로 구성되어 있으며, 기본적으로 주 1챕터씩 진행 시 약 2개월 정도 소요될 것으로 예상됩니다.
• 초반 챕터는 가볍게, 후반부 챕터는 난이도에 따라 빠르게 진행하거나 간단히 토론할 수 있습니다.
• 스터디는 상황에 맞게 유동적으로 운영될 수 있습니다.

📝 규칙

• 스터디 관련 슬랙 메시지 확인 시 다른 팀원들이 알 수 있도록 ✅ 표시를 남깁니다.
• 불참 인원이 있더라도 스터디는 예정대로 진행합니다.
• 불참 시 슬랙을 통해 바로 공유합니다.

📅 진행 일정

🎈 스터디 기간

• 2025.02.28 ~ 2025.04.25

👋 요일별 일정

요일	시간	활동 내용
월	16:00-18:00	코드 비교 및 피드백 공유
금	16:00-18:00	각자 공부한 내용 발표

스터디 분량 및 진행 방식은 도서 수령 후 상황에 맞게 조정될 수 있습니다.

📝 진행 방식

✨ 학습하기 - 금요일, 16:00 ~ 18:00

목표

• 각자 준비한 초안을 하나로 합쳐 토론 과정에서 나온 내용을 반영해 한 권의 책을 완성하는 것을 목표로 합니다.

가이드라인

1. 스터디 전 각자 해당 챕터를 읽고 초안을 자유롭게 작성합니다.
   👉 Clean Code
2. 학습하면서 어려웠던 점, 궁금한 내용, 토론하고 싶은 주제를 정리해 발표를 준비합니다.
   • 발표 자료는 스터디 시작 전까지 각자 자유롭게 준비합니다.
   • 분량은 5~10분 이내로 구성합니다.
3. 토론 후 각자의 초안을 합쳐 논의된 내용을 반영해 챕터를 완성합니다😊

---

💬 코드 리뷰 - 월요일, 16:00 ~ 18:00

목표

• 학습한 내용을 자신의 코드에 직접 적용하고 서로 피드백을 주고받으며 각자의 코드를 개선하는 것을 목표로 합니다.

가이드라인

1. 각자 작성한 코드 리팩토링 및 적용

   • 학습한 챕터의 내용을 본인의 코드에 적용합니다.
   • 수업 시간에 실습한 코드 또는 본인이 작성했던 이전 코드에 적용합니다.

2. 폴더 구조 및 코드 작성 규칙

   • 각자의 코드는 별도의 폴더에 정리합니다.
   • 폴더 구조 예시

     📦 clean-code-study
      ┣ 📂 chapter01
      ┃ ┣ 📂 kjyy08
      ┃ ┃ ┣ 📜 before.java
      ┃ ┃ ┗ 📜 after.java
      ┃ ┣ 📂 user2
      ┃ ┣ 📂 user3
      ┣ 📂 chapter02
      ┣ 📂 chapter03
      ┗ 📜 README.md
     

   • chapterXX/GitHubID/ : 각자 작업한 코드를 개별 폴더에 저장
   • before.java : 개선 전 코드
   • after.java : 개선된 코드

3. 코드 제출 및 공유 (GitHub PR)

   • 리팩토링한 코드를 GitHub에 PR(Pull Request)로 제출합니다.
   • PR 제목: [ChXX] 챕터 제목 - 이름
     • 예시: [Ch01] 깨끗한 코드 - 김주엽
   • PR 본문에는 코드 설명, 개선 내용, 논의할 점을 작성합니다.
   • PR 템플릿 예시

     ## ✨ PR 제목
     
     `[ChXX] 챕터 제목 - 이름`  
     예시: `[Ch01] 깨끗한 코드 - 김주엽`  
     
     ---
     
     ## 🖥️ 간단 소개
     
     본인의 코드에 대해 간단하게 소개해주세요.  
     
     ---
     
     ## 📌 개선 내용
     
     어떻게 개선했는지 간략하게 설명해주세요.  
     
     ---
     
     ## 🧐 논의할 점
     
     다같이 논의하고 싶은 내용이 있다면 적어주세요.
     
     ---
     
     ## ✅ 체크리스트
     
     - [ ] PR 제목이 `[ChXX] 챕터 제목 - 이름` 형식에 맞는가?  
     - [ ] 코드 소개가 간단하고 명확한가?  
     - [ ] 개선 사항이 잘 설명되었는가?  
     - [ ] 논의할 점이 구체적으로 기술되었는가?  

4. 코드 리뷰 및 피드백

   • 스터디 전까지 팀원들의 PR을 확인하고 리뷰를 남깁니다.
   • 리뷰 시에는 좋은 점, 개선할 점 등을 중점적으로 확인합니다.

5. GitHub 브랜치 전략

   • main 브랜치는 직접 수정할 수 없습니다.
   • 개인 작업 브랜치는 chapterXX/GitHubID 형식으로 생성합니다.
     • 예시: chapter01/kjyy08
   • PR이 병합된 후에는 사용한 브랜치를 삭제합니다.

6. GitHub 병합 조건

   • main 브랜치는 보호 브랜치로 설정되며, PR 없이 직접 푸시할 수 없습니다.
   • PR에 새로운 커밋이 추가되면 기존 승인 상태가 취소됩니다.
   • 모든 팀원은 코드 리뷰 과정을 거쳐야 합니다.
   • 모든 팀원의 승인 후 main 브랜치에 병합이 가능합니다.

---

⏳ 유연한 진행 방식

• 내용이 간단한 챕터는 가볍게 진행하고 난이도 높은 부분은 집중적으로 다룹니다.
• 진행 상황에 따라 일정과 방식은 유동적으로 조정됩니다.

👥 멤버

👀 GitHub 프로필

김주엽	김시용	이정우	진소희	박수완
@kjyy08	@KimS1Yong	@AndBlack99	@soheeGit	@cake0420