Effective Java Docs

Contents

Chapter	Due Date
2장 객체 생성과 파괴	24.05.26 ~ 24.06.06
3장 모든 객체의 공통 메서드	24.06.06 ~ 24.06.24
4장 클래스와 인터페이스	TBC
5장 제네릭	TBC
6장 열거 타입과 애너테이션	TBC
7장 람다와 스트림	TBC
8장 메서드	TBC
9장 일반적인 프로그래밍 원칙	TBC
10장 예외	TBC
11장 동시성	TBC
12장 직렬화	TBC

How to contribute docs

Step 1. Fork Study Repo.

스터디 진행을 위해 해당 Repo를 자신의 Repo로 Fork한다.

Step 2. Write Docs

Directory Tree

[폴더 구조]
|- /chapter{n}
|- README.md # Chapter에 대한 Description
|-- /{자신의 Github 아이디}
|--|-- README.md # 아이템들에 대한 Docs 작성
|--|-- /assets # README.md에 들어가는 assets 폴더
|--|--|-- img1.png
|--|--|-- img2.png
|--|-- /src (Optional) # 참고할만한 코드가 있으면 Import
|--|--|--/{package-path}

작성 규칙

• 해당 Chapter 폴더 하위에 자신의 Github 닉네임 (참고) 으로 폴더를 생성.
• 자신의 Github 닉네임 폴더 하위에 Wiki를 작성하는 README.md 파일 작성
  • Chapter에 대한 모든 내용 작성!
  • ❌ Item별로 README 파일을 쪼개면 안됨!!
• 자신의 Github 닉네임 폴더 하위에 assets폴더에는 Wiki에 들어가는 이미지를 Import
  • ❗ 꼭 이미지의 파일 이름은 영문으로 구성되어야 함!! (ex. java-jvm.png)
  • ❗ README.md 파일에 이미지를 임베딩할 경우에는 꼭 상대경로로 지정!!

    ![java-jvm](./assets/java-jvm.png) 
    

WiKi Template

• Wiki를 작성하는 README.md 파일 작성 시에는 template/README.md를 참고하여 작성!!
• README.md 상단에는 YAML frontmatter block을 꼭 달아야 함!!

---
sidebar: auto
lang: ko-KR
title: effective-java-chapter1
---
# ITEM 1. 생성자 대신 정적 팩터리 메서드를 고려하라.
## ~~

# ITEM 2. 생성자에 매개변수가 많다면 빌더를 고려하라.
## ~~

Step 3. Create Pull Request

• WiKi 작성을 완료하였다면, PR(Pull Request)를 생성.
• PR 생성 시 Base Repo의 docs/chapter_xx branch에 생성.
  • PR Title은 [Ch02] 객체 생성과 파괴 - 김경환 과 같은 형식으로 구성.
  • PR Description은 PR Template에 맞추어서 작성!
  • PR Template은 PR 생성 시에 자동으로 구성되도록 설정 완료!

  ## ✏️ 스터디/발표 제목
  - 스터디 혹은 발표에 대한 간략한 내용을 적어주세요
  
  ## 🤔 논의하고 싶은 내용 / 질문 등
  - 학습 내용 기반의 추가적인 논의나 질문 거리에 대해서 작성해주세요
  

  • PR Reviewers은 모든 스터디원으로 설정.
  • PR Assignees은 스터디장 (KyongHwan-Kim)으로 설정.
  • PR Labels은 documentation 으로 설정.
  • PR Development는 [ChXX] Chapter Title로 올라온 Base Repo의 Issue Link
• PR은 격주로 진행하는 회고 완료 후 Merge 수행 예정.
• 각 아이템들을 공부하다가 이해가 되지 않거나 토론할 내용이 있다면 Comment를 남기기.

To do every weeks

• 스터디 장은 Project 기반으로 Chapter별 Issues 생성

📜회고 진행방식

• 해당 Comment에 대해서는 자유롭게 답변을 달아 주시면 됩니다.
• 격주로 오프라인 스터디를 진행합니다.
• 한 사람 당 한개씩 아이템 발표를 진행합니다.
• 매주 한 사람당 한 개의 아이템을 준비하여 발표를 진행합니다.
• 발표 자료는 따로 만들 필요 없이 README와 PR의 Comment를 위주로 진행합니다.
• Effective Java에 나오는 예제 코드 외적으로 자신이 생각하는 적절한 예제코드를 작성하기 (Optional).