Skip to content

Commit aedca04

Browse files
committed
README.md 추가
- 전체 활동 설명 추가 - 참여 방법 추가 - 규칙 및 예시 추가
1 parent 651e5d7 commit aedca04

File tree

1 file changed

+101
-2
lines changed

1 file changed

+101
-2
lines changed

README.md

Lines changed: 101 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,101 @@
1-
# Algorithm-Study
2-
Repository for ALGOHAZA - Algorithm study
1+
## Algorithm-Study : 알고하자
2+
3+
---
4+
5+
## 🤷‍♂️ What is ALGOHAZA?
6+
7+
#### 알고하자는 정기적 알고리즘 풀이를 목적으로 하는 모임입니다.
8+
9+
디스코드에서 운영중이며 모각코, 문제풀이 공유 활동을 진행하고 있습니다.
10+
11+
- `discord` : [`link`]()
12+
- 활동 시기 : `2024/04 ~ `
13+
14+
---
15+
16+
## 🖍 Activity
17+
18+
- 매주 2 회 `PR 기여` 를 진행합니다.
19+
- 매주 1 회 `모각코/문제풀이` 를 진행합니다.
20+
- `PR` 미제출, `모각코/문제풀이` 미참시 경고가 1 회 누적됩니다.
21+
- 경고는 매월 1 일에 초기화되며, 경고 3 회 초과 시 통보 후 퇴출됩니다.
22+
- `PR` 미제출은 어떠한 사유도 허용되지 않으며, `모각코/문제풀이` 사전에 허락받은 사유만 인정됩니다.
23+
24+
## 🍳 `PR 기여`
25+
26+
- `PR 기여` 의 마감일은 매주 `수요일`, `토요일` 의 자정입니다. `(수 -> 목, 토 -> 일 밤)`
27+
- 풀이하는 문제는 각자 자유롭게 선택하며, `PR` 당 최소 1 문제를 풀이해야 합니다.
28+
- 풀이한 문제마다 다음을 포함한 파일들이 존재해야 합니다.
29+
30+
- a. 문제의 간략한 설명
31+
b. 문제 풀이 방법 정리
32+
c. 문제 해결 인증 스크린샷
33+
d. 정답 소스코드
34+
35+
- 각 파일은 `markdown` `(.md)` 으로 제작하는 것을 권장합니다.
36+
- `PR` 제출 후, 관리자의 리뷰에 따라 `PR` 이 승인됩니다.
37+
38+
## 💻 `모각코/문제풀이`
39+
40+
- `모각코/문제풀이` 활동은 매주 `일요일` 에 이루어집니다.
41+
- 해당 활동에 총 2 문제 `(풀이 + 공유 및 발표)` 를 진행합니다.
42+
- `모각코/문제풀이` 활동 중 `웹캠` 은 필수사항이 아니지만, `마이크` 는 필수사항입니다.
43+
- 사전 알림 없이 활동에 미참시 경고 1 회가 누적됩니다.
44+
- 개인 사정으로 참여가 불가할 시, `토요일 23:00` 이전에 공지해야 합니다. 이후의 공지는 받지 않습니다.
45+
46+
---
47+
48+
## 💡 참여 방법
49+
50+
1. 이 저장소를 `fork` 한 후, 각 멤버별 `{Github ID}` 폴더를 만듭니다.
51+
2. 폴더 내 풀이한 문제를 `정리` 합니다.
52+
3. `PR` 템플릿에 맞춰 이 저장소에 `PR` 을 보냅니다.
53+
4. 관리자의 `PR` 리뷰에 따라 `PR` 이 승인되거나 보충됩니다.
54+
55+
56+
## 📁 문제 정리 구조
57+
58+
문서 구조는 크게 `M_{활동연도}_{월}`, `{주차수}`, `{풀이 문제}` 로 나뉩니다.
59+
60+
```
61+
jbw9964/ # 멤버 별 활동 폴더
62+
├── M_2024_03
63+
└── M_2024_04 # 활동 연도/월
64+
├── Week_2
65+
└── Week_3 # 활동 주차 수
66+
├── P_2609 # 풀이 문제
67+
│   ├── README.md # 문제 설명 + 풀이 정리
68+
│   ├── Solution_2609.java # 정답 소스코드
69+
│   └── approval_2609.PNG # 인증 스크린샷
70+
└── P_10950
71+
├── README.md
72+
├── Solution_10950.java
73+
└── approval_10950.PNG
74+
75+
6 directories, 6 files
76+
```
77+
78+
각 멤버별 활동 폴더 `(예시 : jbw9964)` 내 위 구조처럼 조직합니다.
79+
80+
- `M_{활동연도}_{월}` 폴더는 해당 `연도/월` 에 활동한 내역을 저장합니다.
81+
- `{주차수}` 폴더는 활동한 주차별로 제작합니다.
82+
- `{풀이 문제}` 폴더는 `풀이한 문제` 를 기록하는 폴더입니다.
83+
84+
---
85+
86+
## `Commit 예시` & `PR` 규칙
87+
88+
#### - [`Commit 예시`](./docs/rules/github_repository/commit_and_organization.md#🔖-commits)
89+
90+
#### - [`PR 규칙`](./docs/rules/github_repository/pr_rules.md)
91+
#### - [`PR 템플릿`](./docs/pull_request_template.md)
92+
93+
---
94+
95+
## 👋 Members
96+
97+
| ![image](https://github.com/jbw9964) | |
98+
|:---:|:---:|
99+
|`jbw9964`| |
100+
101+
---

0 commit comments

Comments
 (0)