Skip to content

Commit

Permalink
docs(README.md): 스터디 진행 방식 및 컨벤션 생성
Browse files Browse the repository at this point in the history
  • Loading branch information
semi-cloud authored May 15, 2023
1 parent c948969 commit a3f448c
Showing 1 changed file with 46 additions and 1 deletion.
47 changes: 46 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,47 @@
# effective-java-study
📚 디프만 13th 이펙티브 자바 스터디 레포
📚 디프만 13th 이펙티브 자바 스터디

### ☁️ 스터디 구성원
| Backend | Backend | Backend | Backend | Android |
| :-----------------------------------------------------------: | :---------------------------------------------------------: | :---------------------------------------------------------: | :--------------------------------------------------------: | :--------------------------------------------------------: |
| <img src="https://avatars.githubusercontent.com/u/71436576?s=400&u=9f8f3d0a343d7733d6c62beae26821f6a53b7d7f&v=4" width=400px alt="강세미"/> | <img src="https://avatars.githubusercontent.com/u/64088250?v=4" width=400px alt="김동호"/> | <img src="https://avatars.githubusercontent.com/u/41619898?v=4" width=400px alt="박건호"/> | <img src="https://avatars.githubusercontent.com/u/87802191?v=4" width=400px alt="손시연"> | <img src="https://avatars.githubusercontent.com/u/80201773?v=4" width=400px alt="정성훈"> |
| [강세미](https://github.com/semi-cloud) | [김동호](https://github.com/kdomo) | [박건호](https://github.com/gunh0) | [손시연](https://github.com/siyeonSon) | [정성훈](https://github.com/seonghun-dev) |

### ☁️ 진행 방식

#### 스터디 방식
+ 각 주차마다 5개의 아이템을 읽고 질문 및 논의할 사항을 찾아온다.
+ 스터디 전까지 본인이 맡은 아이템에 대해 다음과 같은 내용을 정리해온다.
> 1. 챕터 폴더 내부에 발표할 정리본 파일 생성(책 내용을 넘어선 외부 자료 인용 환영)
> 2. 본인이 읽다가 이해 안되는 구문 및 질문
> 3. 실제 아이템이 적용되는 자바 소스 코드 찾아오기
+ 발표 순서
```
강세미 → 김동호 → 박건호 → 손시연 → 정성훈
```

#### 폴더 구조
```
|-- Ch01
|-- item01
- 생성자_대신_정적_팩터리_메서드를_고려하라.md
|-- item02
|-- Ch02
|-- item03
```

#### PR 규칙
1. 해당 레파지토리를 Fork 한다.
2. 챕터 내부에 item0X 폴더를 생성하고 [아이템 이름]으로 마크다운 파일을 작성한다.
3. 본인에게 선정된 아이템 이슈를 생성하고, 커밋할 때 아래 형식을 참고해서 이슈 번호를 연동시킨다.
+ 해당 아이템에 관련한 모든 논의 및 질문 사항은 이슈에 기록해놓고, 이를 바탕으로 스터디에서 논의한다.
+ 이슈 제목 : `[ItemXX] 질문 제목`
5. 토요일 밤 12시까지 PR을 올린다.

#### 커밋 규칙
+ `[ItemXX]: 아이템 제목 (#이슈번호)(작성자)`

### ☁️ 참고 레포
+ [우아한 테크코스 자바 스터디](https://github.com/woowacourse-study/2022-effective-java)

0 comments on commit a3f448c

Please sign in to comment.