Skip to content

Commit 13207e5

Browse files
committed
Docs: README.md 추가
0 parents  commit 13207e5

1 file changed

Lines changed: 195 additions & 0 deletions

File tree

README.md

Lines changed: 195 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,195 @@
1+
# 🧮 Python Calculator (Team Project)
2+
3+
Python으로 구현하는 **CLI 기반 계산기 프로그램**입니다.
4+
이 프로젝트는 Git을 활용한 **branch 기반 협업 workflow**를 학습하기 위한 팀 프로젝트입니다.
5+
6+
---
7+
8+
# 🎯 프로젝트 목표
9+
10+
이 프로젝트의 목표는 다음과 같습니다.
11+
12+
* Python을 활용한 간단한 프로그램 구현
13+
* Git branch 기반 협업 workflow 이해
14+
* Pull Request 기반 협업 경험
15+
* 팀 단위 Git 협업 경험
16+
17+
---
18+
19+
# 🛠 구현 기능
20+
21+
기본적으로 아래 기능을 구현해야 합니다.
22+
23+
```
24+
1. 덧셈
25+
2. 뺄셈
26+
3. 곱셈
27+
4. 나눗셈
28+
```
29+
30+
예시 실행 결과
31+
32+
```
33+
첫번째 숫자 입력: 10
34+
연산 선택 (+ - * /): +
35+
두번째 숫자 입력: 5
36+
37+
결과: 15
38+
```
39+
40+
추가적으로 아래 기능을 구현할 수 있습니다.
41+
42+
```
43+
- 잘못된 입력 처리
44+
- 0으로 나누기 예외 처리
45+
- 반복 실행 기능
46+
```
47+
48+
---
49+
50+
# 📂 프로젝트 구조
51+
52+
예시 구조
53+
54+
```
55+
calculator
56+
┣ src
57+
┃ ┗ calculator.py
58+
┗ README.md
59+
```
60+
61+
⚠️ **주의**
62+
63+
위 구조는 **예시일 뿐이며 반드시 동일하게 구현할 필요는 없습니다.**
64+
각 팀은 **자유롭게 프로젝트 구조를 설계하여 구현해야 합니다.**
65+
66+
---
67+
68+
# 🌿 Git 협업 방식
69+
70+
이 프로젝트는 **Branch 기반 협업 방식**으로 진행됩니다.
71+
72+
각 팀은 먼저 **팀 branch를 생성**해야 합니다.
73+
74+
예시
75+
76+
```
77+
team-1
78+
team-2
79+
team-3
80+
```
81+
82+
이후 팀 내부에서 기능별 branch를 생성하여 개발합니다.
83+
84+
예시
85+
86+
```
87+
feature/add
88+
feature/subtract
89+
feature/multiply
90+
feature/divide
91+
```
92+
93+
또는
94+
95+
```
96+
team-1/add
97+
team-1/subtract
98+
team-1/multiply
99+
team-1/divide
100+
```
101+
102+
⚠️ **주의**
103+
104+
브랜치 전략은 예시이며 **반드시 동일하게 사용할 필요는 없습니다.**
105+
106+
각 팀은 **자체적으로 협업 전략을 설계하여 진행해야 합니다.**
107+
108+
---
109+
110+
# 🔀 권장 Git Workflow
111+
112+
권장되는 작업 흐름
113+
114+
```
115+
1. 팀 branch 생성
116+
2. 기능 branch 생성
117+
3. 기능 구현
118+
4. commit
119+
5. GitHub push
120+
6. Pull Request 생성
121+
7. 팀 branch merge
122+
```
123+
124+
Pull Request 기반 협업을 권장합니다.
125+
126+
---
127+
128+
# 📌 Commit 규칙
129+
130+
예시
131+
132+
```
133+
feat: add addition function
134+
feat: add subtraction function
135+
fix: division by zero error
136+
```
137+
138+
⚠️ **주의**
139+
140+
위 commit 메시지 규칙은 **예시입니다.**
141+
142+
각 팀은 **자체 commit 규칙을 정하여 사용해야 합니다.**
143+
144+
---
145+
146+
# ▶ 실행 방법
147+
148+
예시
149+
150+
```bash
151+
python calculator.py
152+
```
153+
154+
⚠️ 실행 방법 역시 **프로젝트 구조에 따라 달라질 수 있습니다.**
155+
156+
---
157+
158+
# 📤 제출
159+
160+
별도의 파일 제출은 하지 않습니다.
161+
162+
각 팀은 다음 정보를 제출합니다.
163+
164+
```
165+
팀 branch 이름 또는 branch 링크
166+
```
167+
168+
---
169+
170+
# ✅ 평가 기준
171+
172+
| 항목 | 비율 |
173+
| ------ | --- |
174+
| 기능 구현 | 40% |
175+
| 코드 구조 | 10% |
176+
| Git 사용 | 50% |
177+
178+
평가 시 아래 항목을 확인합니다.
179+
180+
* 팀 branch 존재
181+
* 최소 **4개 이상의 branch 사용**
182+
* Pull Request 기록 존재
183+
* 팀 branch에 최종 코드 존재
184+
* 프로그램 정상 실행
185+
* README 작성
186+
187+
---
188+
189+
# ⚠️ 중요 안내
190+
191+
다음 사항을 반드시 확인하세요.
192+
193+
* 예시 코드를 그대로 복사하여 제출하는 것은 허용되지 않습니다.
194+
* 브랜치 전략 및 프로젝트 구조는 **팀 내부에서 설계해야 합니다.**
195+
* GitHub 협업 기록이 평가에 포함됩니다.

0 commit comments

Comments
 (0)