README.md

code-itch

목표

• 혼자 읽기 힘든 이펙티브 타입스크립트를 같이 공부한다.
• 이해되지 않는 문장이 있다면, 그대로 넘기지 않는다.
• 이 스터디를 통해 typescript의 전반적인 부분에 대해 이해를 한다.

기간

• 2개월
• 2023.12.초 ~ 2024.02.10(?)
• 매주 목요일 (16:00 ~ 17:00) 오프라인으로 진행
• 오프라인 참석이 힘들 경우 전날에 전달

스터디 방식

1. 스터디 진행 방식은, 그 주 진행자가 결정한다.

   • 예시 : 주간 회고 -> 아이템 공유 -> 스터디에 대한 의견 조율
   • 회고는 2주일간 진행하면서, 아쉬웠던 부분 혹은 어떻게 개선해야 겠다는 생각, 그 주 자신과 관련된 이슈등을을 말하도록 한다.

2. 매주 item 1개씩, 담당 item이 하나 존재

   • ps) 해당 Item 자체 내용이 적거나, 혹은 너무 어렵다면 item 할당에 대해 스터디원간 합의하여 유동적으로 조율한다.

3. 이슈 생성 담당자는 repo에 issue를 생성함

   • 이슈 생성 시, 순서에 맞춰 생성한다.
   • 생성된 issue는 팀원들 간에 소통의 공간이다.
   • 팀원들은, 한 주간 정한 item들을 공부하면서 생겼던 질문들을 적합한 issue에 남기고, 해당 item 담당자는 질문에 대한 대답을 남긴다.
     • 대답은, 간단한 줄글 부터 예시 코드까지 작성할 수 있음.
     • 최대한 답변자가 이해할 수 있게 쉽게 설명.
   • 담당자가 해결하지 못하는 질문, 내용은 매주 목요일 미팅 시간에 공유하여, 해결하도록 한다.
     • 해결되지 못한 item 넘어가자 --> 너무 완벽하게, 깊게 파고들려고 하지 말자.
     • 해당 질문이 간단해서, 검색을 통해 해결될 수 있는 문제라면 조사 후, issue 댓글로 정리 내용을 공유하기로 한다.
   • 또한, 공유하고 싶은 문서등을 자신의 담당이 아닌 댓글에 추가할 수 있다.

4. Item 담당자는 item에 대한 정리(질답 내용을 포함) 하여 markdown file로 commit 한다.

   • 커밋 메세지는, 아이템명과 동일하다
     • 메세지 예시 --> [아이템 08] 타입 공간과 값 공간의 심벌 구분하기
   • 저장 방식(예시)
     • effective-typescript (repo)
       • chapter2
         • item01.md
   • 해당 commit은 가능한 그 주내에 할 수 있도록 한다.
   • README에 item 정리한다 (스터디 끝나고 진행할 것)
   • branch는 모두 main로 진행
     • 커밋 title, 은 issue 이름과 동일하게 한다.

5. item 정리 방식

   • 개개인 담당자에게 맡기지만, 남들이 봤을 때도(초급자가 봤을 때도) 이해할 수 있을 정도로 정리.
   • 이미지는 issue에 올리고, 그 주소를 사용하는 걸로 한다.
     • 따로 이미지 폴더를 관리하지 않음
   • 소스코드도 같이 사용하고 싶다면 같이 포함할 것

6. 쉽게 결정할 수 없는 문제는 사다리 타기 이용한다.

7. 위 스터디 방식은 팀원과의 합의를 통해, 언제든지 수정 가능하다.

Ground Rule

• 매주 화요일까지 각자 아이템 정리 글 Github로 올리기

• 매주 수요일까지 개인당 질문 하나 무조건 하기(본인 아이템 제외하고 아무 아이템 가능)

• 그 전주 수요일까지, 그 주 스터디에 대해 참가여부를 디스코드로 알려줄 것.

  • 그 주 스터디 참가인원이 3명 미만일 경우, 희망자 의견에 따라 스터디가 연기 될 수 있음.

• 다음주 진행자 역할

  • 아이템 issue 만들기
  • 다음주 스터디를 진행하기 (진행 방식은 각자 재량)
  • 스터디 회고록

대화 수칙

• 우린 '근거'를 통해 피드백하며 '무분별한 비난'은 하지 않습니다.
• 우린 '경청'을 노력하며, '피드백'을 환영합니다.
• 우린 누구나 자유롭게 의견을 낼 수 있지만 '나만 정답이다'라는 태도를 지양합니다.

기타

Reference

• 위어소프트
• java-squid