Skip to content

Commit a6db44f

Browse files
committed
refactor: main 레포 README에 변경된 내용 업데이트
1 parent d1400bf commit a6db44f

File tree

1 file changed

+82
-51
lines changed

1 file changed

+82
-51
lines changed

README.md

Lines changed: 82 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,102 @@
11
# 💯 알고리즘 및 코딩 테스트 문제 풀이 스터디📝
22

3+
알롬버스에 오신 것을 환영합니다! 이 저장소는 코딩 테스트 대비 및 알고리즘 실력 향상을 목표로 하는 스터디 그룹의 문제 풀이와 학습 기록을 담고 있습니다.
4+
스터디 멤버들은 발제자 시스템을 통해 매주 새로운 문제를 풀고, 함께 코드 리뷰를 진행하며, 꾸준히 성장해 나갑니다. 아래의 가이드를 참고하여 참여해 주세요!
5+
6+
<br />
7+
8+
## 🚀 스터디 목표
9+
1. **목표 실력 향상**: 각 팀원은 자신만의 목표를 가지고 있으며, 프로그래머스 Level 2-3 문제와 백준 실버~골드 문제를 힌트 없이 스스로 풀 수 있도록 문제 패턴을 익히고 실력을 단계적으로 향상합니다.
10+
2. **코딩 습관 형성**: 꾸준한 문제 풀이를 통해 일상적인 코딩 습관을 기르고, 난이도 있는 문제에도 도전하는 과정을 통해 자신감을 키웁니다.
11+
3. **패턴 학습과 문제 해결 속도 향상**: 특정 문제 패턴에 익숙해져 빠르고 효율적으로 문제를 풀 수 있는 실력을 목표로 합니다.
312
<br />
413

5-
## 🚩스터디 목표
6-
1. 코딩 테스트를 대비하여 알고리즘 문제 풀이 실력을 향상시킨다.
7-
2. 꾸준하게 문제 풀이한다.
14+
> 자세한 설명은 메인 [README](https://github.com/AlgorithmStudy-Allumbus)를 참고해주세요!
15+
>
816
917
## ✅ 참여 방법
10-
1. 이 저장소를 `fork` 한다.
11-
- Fork 하지 않고 Pull Request하면 본인의 잔디에 커밋이 남지 않으니, 꼭 fork하기
12-
3. 생성된 원격 저장소에 `이름` 혹은 `github ID`로 폴더를 생성한다.
13-
4. 생성된 폴더에 자신의 소스코드를 업로드 한다. (폴더명에 콜론":" 안됩니다!)
14-
5. 이때 `commit 규칙`을 지키도록한다!
15-
6. 원본 저장소로 `Pull Request`를 한다.
16-
- PR은 스터디 시간 전까지 올리기!
17-
- 스터디 날에 발제자가 한번에 Merge 할 예정입니다!
18-
7. 다른 사람들의 PR을 보고 자유롭게 코드리뷰를 한다.
19-
8. ***주의!! 기존 폴더를 지우면 안됩니다!!*** 개인 폴더 내부만 수정해주세요 :)
18+
1. 이 저장소를 `fork`합니다.
19+
- **주의**: Fork 후 Pull Request(PR)를 해야 개인 GitHub의 잔디가 기록됩니다.
20+
2. 생성된 원격 저장소에 본인의 `이름` 또는 `GitHub ID`로 폴더를 생성합니다.
21+
3. 폴더에 자신의 소스 코드를 업로드합니다. (폴더명에 콜론 `:`을 사용하지 마세요!)
22+
4. **Commit 규칙**에 따라 커밋 메시지를 작성합니다.
23+
5. **PR 제출**: 스터디 시간 전까지 PR을 제출합니다.
24+
- 스터디 당일 발제자가 PR을 한 번에 Merge할 예정입니다.
25+
6. 다른 멤버의 PR을 보고 자유롭게 코드 리뷰를 진행합니다.
26+
7. ***주의! 기존 폴더를 삭제하지 마세요.*** 개인 폴더 내부만 수정해 주세요. 😊
2027

21-
<br />
2228
<br />
2329

2430
## ✅ 소스코드 파일 이름 규칙
25-
- 자유롭게 작성
26-
- ❌폴더명 또는 소스코드 파일명에 콜론 ":" 안됩니다 :D
27-
- ❌폴더명에 한글 이름도 자제해주세요! 맥OS에서는 되지만, 윈도우에서는 `git clone succeeded but checkout failed` 와 관련한 에러가 발생합니다
28-
29-
30-
## ✅ commit 규칙
31-
- commit 메세지: [문제 출처(플랫폼)] 문제이름 / 난이도 / 걸린시간
32-
- description: 문제 주소 (option)
33-
- 터미널에서 작성법:
34-
```
35-
git commit -m "[BOJ] Hello World / 브론즈5 / 1분" -m "https://www.acmicpc.net/problem/2557"
36-
```
37-
- 플랫폼 작성법 통일:
38-
* [BOJ] - 백준
39-
* [PGS] - 프로그래머스
40-
* [LTC] - 리트코드
41-
* [CFS] - 코드포스
42-
* [SEA] - 삼성SW Expert Academy
43-
* [ETC] - 그외
31+
- 자유롭게 작성 가능
32+
- ❌폴더명 및 파일명에 콜론 `:` 사용 금지 (OS 차이 때문)
33+
- ❌폴더명에 한글 이름 사용 자제 (Windows 환경에서 `git clone` 시 에러가 발생할 수 있습니다)
4434

4535
<br />
36+
37+
## ✅ Commit 규칙
38+
- **커밋 메시지 형식**: `[문제 출처(플랫폼)] 문제이름 / 난이도 / 걸린시간`
39+
- **Description**: 문제 주소 (옵션)
40+
- **예시**:
41+
```bash
42+
git commit -m "[BOJ] Hello World / 브론즈5 / 1분" -m "https://www.acmicpc.net/problem/2557"
43+
```
44+
- **플랫폼 표기**:
45+
- [BOJ] - 백준
46+
- [PGS] - 프로그래머스
47+
- [LTC] - 리트코드
48+
- [CFS] - 코드포스
49+
- [SEA] - 삼성SW Expert Academy
50+
- [ETC] - 기타
51+
4652
<br />
4753

4854
## ✅ PR 규칙
49-
- PR 제목: 이름 / 주차 / 몇 문제
50-
- ```jaewon han / 8월 1주차 / 4문제 ```
51-
- comment는 자유이나 가능하다면, 이번주에 풀었던 문제의 알고리즘 분류가 어떻게 되는지, <br> 어떤 문제가 어려웠는지 회고를 작성한다면 개인에게도 도움되고 다른 코드 리뷰어가 참고하기 좋을 것 같습니다 :)
55+
> 매주 토요일 23:59까지 올리기
56+
- **PR 제목**: 이름(또는 Github ID) / 주차 / 풀이한 문제 수
57+
- 예시: `Minjeong / 8월 1주차 / 4문제`
58+
- **PR 코멘트**: 자유롭게 작성 가능. 가능하다면 문제의 알고리즘 분류와 주간 학습 회고를 작성하면 리뷰에 도움이 됩니다.
59+
<br />
5260

61+
## ✅ 코드 리뷰 규칙
62+
> 매주 일요일 23:59까지 올리기. 월요일 스터디 전까지 자신의 리뷰들을 읽고 오기
63+
- **PR에서 발제자가 정한 해당 주차의 과제에 대해 팀원 간 코드 리뷰**를 진행합니다.
64+
- 전체 코드 흐름을 파악하고 이해한 후 리뷰 의견을 남깁니다.
65+
- 잘했다고 생각하는 부분
66+
- 개선하면 좋을 것 같은 부분
67+
- 궁금한 점 또는 다른 풀이 제안
68+
- 코드의 특정 부분에 댓글을 남기거나, 전체 코드 또는 PR 하단에 코멘트 작성 가능
5369

54-
<br />
55-
<br />
5670

57-
## ✅ (option)코드리뷰 규칙
58-
- PR에서 코드리뷰를 한다.
59-
- 전체 코드 흐름을 파악한 뒤, 이 분이 어떻게 풀었을까 이해를 한 후
60-
- 의견제시
61-
- 잘했다고 생각하는 부분
62-
- 이렇게 하면 더 좋을 것 같다고 생각하는 부분
63-
- 왜 이렇게 풀었는지 궁금한 부분
64-
- 또 다른 풀이 방식 제시
65-
- 코드의 일부분에다 코드리뷰를 해도 되고 전체 코드 밑 or PR 하나 밑에다 코멘트 작성으로 리뷰를 해도 됩니다.
66-
67-
코드 리뷰 참고 사이트: https://devlog-wjdrbs96.tistory.com/231
68-
<br />
71+
[코드 리뷰 참고 사이트](https://devlog-wjdrbs96.tistory.com/231)
72+
6973
<br />
7074

71-
ReadMe 내용 참조: https://github.com/ellynhan/challenge100-codingtest-study/edit/master/README.md
75+
## 📚 발제 및 주차별 활동
76+
매주 **발제자**가 선정한 문제를 기반으로 문제 풀이와 코드 리뷰를 진행합니다. 발제자는 **발제 폴더**에 각 주차별 문제와 해설 자료를 업로드하며, 문제 유형과 설명은 `README.md` 파일에 정리됩니다.
77+
78+
- **폴더 구조**:
79+
```plaintext
80+
📁 발제
81+
├── 📁 W01-[Graph]
82+
│ ├── README.md # 발제자가 문제와 풀이 자료 정리
83+
│ └── 발제자가_준비한_답지.py
84+
85+
- 발제 자료 위치: 발제자가 준비한 PPT와 문제는 주차별 폴더의 README.md에 정리됩니다. ([_WeeklyChallenges](https://github.com/AlgorithmStudy-Allumbus/codingtest_algorithm_study/tree/main/_WeeklyChallenges))
86+
87+
88+
## 👥 스터디 멤버
89+
90+
| 이름 | 역할 | GitHub ID | 목표 문제 수 | 목표 난이도 | 시작한 날짜 |
91+
|-----|-----|-----------|--------------|------------------------------|--------------|
92+
| 김민정 | 팀장 | [@Mingguriguri](https://github.com/Mingguriguri) | 5문제 | [PGS] Level 2 / [BOJ] 실버 이상 | 2023.12.20 ~ |
93+
| 김홍주 | 발제자 | [@zaqquum](https://github.com/zaqquum) | 3문제 | [PGS] Level 2 / [BOJ] 실버 이상 | 2024.02.01 ~ |
94+
| 조윤상 | 팀원 | [@YoonYn9915](https://github.com/YoonYn9915) | 3문제 | [BOJ] 실버 이상 | 2024.07.01 ~ |
95+
| 정수미 | 팀원 | [@learntosurf](https://github.com/learntosurf) | 5문제 | [PGS] Level 1 / [BOJ] 브론즈 이상 | 2024.11.01 ~ |
96+
97+
### 이전 멤버 ([_AllumniContributions 폴더](https://github.com/AlgorithmStudy-Allumbus/codingtest_algorithm_study/tree/main/_AlumniContributions))
98+
99+
| 이름 | 역할 | GitHub ID | 참여 기간 |
100+
|-----|------|-----------------|-------------------|
101+
| 고중범 | 팀원 | [@Kojungbeom](https://github.com/Kojungbeom) | 2023.12 - 2024.04 |
102+
| 박재윤 | 팀원 | [@JYP0824](https://github.com/JYP0824) | 2023.12 - 2024.04 |

0 commit comments

Comments
 (0)