2Digit 클린코드 사내 스터디를 위한 레파지토리입니다.
안녕하세요! 🙇♂️ 2022 클린코드 스터디장 🦒기린입니다!
해당 부분에서는 클린코드 스터디가 어떻게 진행되는지에 대한 방식 및 스터디원이 지켜야 할 규율에 대해서 명시합니다.
아래 소개 부분에서는 주저리 주저리를 적어두었으니 보기 힘드신 분은 패스하셔도 됩니다.
클린코드는 애자일 방법론을 따르며, 그러한 개발 방법론에 있어 코딩 가이드 제공합니다.
애자일 방법론이란 일정한 주기를 갖고 개발하는 최신 트랜드 개발 방법론이며, 클린코드는 팀원들과 협업을 함에 있어 그런 개발을 하기위한 지침서라고 보면 됩니다.
애자일에 대해 알고 싶다면?
개발을 하다보면 여러 코드에 대해 마주치게 됩니다.
버전, 호환성 등이 맞지 않아 발생하는 오류 코드, 이론 자체가 어려워서 적기 힘든 코드, 전임 개발자가 만들어 적어 놓은 이상한 코드, 혹은 내가 예전에 적어놓은 의미를 알수 없는 코드, 우리는 개발을 하면서 이러한 여러 코드들을 마주해야만 합니다.
하지만 눈치가 빠른 분들은 이미 아시겠지만 클린 코드는 애자일 지침서라고 한 만큼, 앞서 말한 두 가지 코드에 대해서는 심도있게 다루지 않습니다.😭
클린코드는 협업을 할 때 어떻게 코드를 작성해야 다른 사람이 보기 좋은지, 내가 보기 좋은지, 어떻게 유지보수를 해나가면 좋은지에 대한 방법론이며, 절차를 명세한 책입니다.
프로그래밍 역사상 개발 언어, 분야를 불문하고 가장 많이 팔린 베스트셀러이기도 합니다. 또한 최근 사내 스터디에서 인기 있는 주제가 되기도 합니다.
모든 직군이 그러하지만, 개발자는 협업하는 사람으로써 필연적으로 다른 사람에게 자신이 쓴 코드를 보여야 합니다.
개인의 역량이 어떠한지 자세히는 모르지만, 적어도 해당 스터디에 오신 분들은 자신이 지금까지 써 온 코드에 대해서 한번쯤은 고민을 하셨던 분이라고 생각합니다.
이 스터디가 여러분의 기대에 부응하여 최소한 부끄럽지 않은 코드를 쓸 수 있는 이정표가 되기를 기원합니다.
아래의 도서로 스터디가 진행됩니다.
- 해당 스터디는 각자 다른 사람이 다른 챕터들을 각기 다른 파일로 정리하여 업로드 하는 방식으로, 기타 작업 브런치를 필요로 하지 않습니다.
따라서Organization Repository에 직접Push하는 방법을 사용합니다. 자신이 맡은 회차마다 돌아가면서Push를 한다고 보시면 됩니다.
단 별도로 참고 자료, 발표자료 등을 업로드 할 경우
chapter-챕터번호로 브런치를 만들어 업로드 하길 바랍니다.
-
커밋의 수는 상관하지 않습니다. 단, 본인의 회차에 발표할 내용은 모든 스터디 원이 자리에서
Github을 통해 확인할 수 있도록 모든 내용이 업로드 되어있어야 합니다. -
아래에는 각 회차별로 스터디원 여러분이 정리해야 할 챕터가 명시되어 있습니다. 각 챕터별로 정리 후에
books/폴더에Push해주시면 됩니다. -
파일명은
books/clean-code-chaptor-챕터번호-이름.md순으로 명세합니다. -
스터디는 각 주차별로 본인이 정리한 내용을 가지고 본인의 차례에 발표하며 진행됩니다. 📣
-
모든 챕터의 정리가 끝나면 해당
Markdown문서들을 모아Wikidocs로 편찬하고, 스터디원 여러분의 기여를 명시할 예정입니다.🧑💻 -
각 스터디원의 기여도를 함께 시각적으로 명시할 예정이며, 각 기여도는 해당 레파지토리의
커밋에 담긴 글자 수로 계산하여 한정합니다.✅
커밋이 많고 적음은 계산하지 않습니다, 추후 스펙으로 활용하시길 바랍니다. 📑
-
본
Repositoy는Public으로 설정되어 있습니다. 사내 코드를 해당 레파지토리에 예시로써 업로드 하는 것을 허용하지 않습니다. 🚫 -
질문이나 토론거리는
Disscusion란에 올려주세요.
어른이니까 지켜주세요 😂
-
본인이 발표하는 날에는 꼭 오도록 합니다. 🙏
-
회사의 행사 등으로 인한 불참은 허용하며 카운트되지 않습니다. ✅
-
개인사정으로 인해 스터디 중도 이탈 시 챕터 재조정을 위해 최소 1주 전에는 말해주세요 🙏
- 연속 3회 불참은 강퇴처리합니다. (단 강퇴되었더라도 본인이 작성한 내용에 대해서는 기여도를 측정하여 위키에 명시합니다.)
3회 연속으로 아프진 않겠죠
원칙은 단위당 최소 4개의 중단원 정리를 목표로 합니다.
| Erin | Giraffe |
|---|---|
| 매주 화요일 | 매주 금요일 |
공지사항, 사소한 질문, 스터디 관련 질문, 경조사 알림 등은 해당 오픈채팅방을 활용하도록 할게요! 👩👩👧👦
해당 스터디는 2022-06-27을 기점으로 종료되었으며, 결과물은 아래 Wikidocs.net에 공유되었습니다.
Wikidocs: https://wikidocs.net/book/8131