[VS Code 설치가 처음인 분들을 위한 참고 가이드]
[VS Code가 설치되어있다면 여기부터 보시면 됩니다!]
[코랩에서도 깃허브 연동이 가능하나 아래 3. [중요] 과제 제출 가이드를 참고하셔서 VS Code에서 진행하는 것을 권장합니다!]
본 제출가이드는 Momentum n기 정규 & 방학세션의 주차별 과제 제출 시 참고하시면 됩니다.
안전한 코드 관리와 원활한 피드백을 위해 다른 팀원의 폴더나 공통 파일(README.md 등)은 수정하시면 안 됩니다.
- 제출 마감: 목요일 18시 00분 세션 시작 전
- 제출 확인: 운영팀에서 과제가 있는 주차 금요일에 PR을 확인하고 리뷰(의견)를 남기거나 병합(Merge)하여 과제 제출을 확인합니다.
- 부원별로 해야 할 것: 매주 토요일, 본인의 과제가 정상적으로 병합(Merge)되어 제출 완료되었는지 확인합니다.
과제 제출은 반드시 본인의 브랜치를 생성하여 Pull Request(PR)를 진행하는 방식으로 제출합니다.
- 로컬 환경에 레포지토리 클론 (VSCode, 터미널 등)
git clone https://github.com/Momentum-Research-Team/session-assignment.git- 본인 작업용 브랜치 생성 및 이동
# 예시: 1주차 홍길동 브랜치 생성
git checkout -b week1-hong- 과제 폴더 생성 및 파일 업로드
- 해당 주차 폴더(예:
n기 방학세션/1주차/) 내부로 이동합니다. - 본인 이름으로 폴더를 생성합니다. (예:
n기 방학세션/1주차/홍길동/) - 폴더 내에서 직접 과제를 수행하거나, 작업한 과제 파일을 해당 폴더에 넣습니다.
※ 구글 코랩(Colab) 사용자를 위한 안내 많은 분들이 코랩으로 수업을 진행하시는 것으로 알고 있습니다. 코랩에서 직접 깃허브를 연동하는 것은 토큰 인증이나 세션 종료 등 번거로운 절차가 필요합니다. 따라서, 코랩 사용자는 작업이 끝난 후
.ipynb나.py형태로 파일을 다운로드하여 VSCode로 열어둔 본인 로컬 폴더에 넣은 뒤 위 순서대로 진행하시면 됩니다.
- 변경 사항 추가(Add) 및 커밋(Commit)
# 본인 폴더의 변경 사항만 추가 (예시)
git add "n기 방학세션/1주차/홍길동"
# 커밋 메시지 작성 (예시)
git commit -m "docs: 1주차 홍길동 과제 제출"- 원격 저장소에 푸시(Push)
# 생성했던 본인 브랜치 이름으로 푸시합니다
git push origin week1-hong- Pull Request (PR) 생성
- 푸시를 완료한 후, GitHub 레포지토리 웹사이트에 접속합니다.
- 상단에 활성화된
Compare & pull request버튼을 클릭하여 PR을 생성하면 제출이 완료됩니다.
본 프로젝트는 일관된 커밋 히스토리 관리와 가독성을 위해 Conventional Commits 규칙을 따릅니다. 모든 커밋 메시지는 아래 규칙을 준수하여 작성해 주세요.
커밋 메시지는 기본적으로 제목, 본문, 바닥글 구조를 가집니다. 본문과 바닥글은 필요한 경우에만 작성하며, 각 섹션은 빈 줄로 구분합니다.
<Type>: <Subject> <Body> Footer ```
- **Type**: 작업의 종류를 나타내는 태그 (소문자로 작성)
- **Subject**: 변경 사항에 대한 간결한 요약 (50자 이내, 끝에 마침표 금지)
---
### 🛠️ Commit Type
| Type | Description |
| :--- | :--- |
| `feat` | 새로운 기능 추가 |
| `fix` | 버그 수정 |
| `docs` | 문서 수정 (README.md, 주석, 위키 등) |
| `style` | 코드 포맷팅, 세미콜론 누락 등 (로직 변경 없는 경우) |
| `refactor` | 코드 리팩토링 (기능 추가나 버그 수정이 없는 구조 개선) |
| `test` | 테스트 코드 추가 및 수정 |
| `chore` | 빌드 업무, 패키지 매니저 설정, 환경 설정 변경 등 |
| `design` | CSS 등 사용자 UI 디자인 변경 |
---
### 📝 작성 예시
#### 1. 제목만 작성하는 경우 (가장 흔한 케이스)
```text
feat: 구글 소셜 로그인 기능 추가
---
## 🛠️ 참고 자료
- [2025 최신 VS Code 설치 가이드](https://firefly7.tistory.com/entry/2025-%EC%B5%9C%EC%8B%A0-VS-Code-%EC%84%A4%EC%B9%98-%EA%B0%80%EC%9D%B4%EB%93%9C)
- [Git & GitHub 기초 사용법 가이드](https://jamong.tistory.com/4)
- [구글 코랩(Colab) - 깃허브 연동 가이드](https://angidgidtn.tistory.com/entry/Colab-%EA%B5%AC%EA%B8%80-%EC%BD%94%EB%9E%A9-%EA%B9%83%ED%97%88%EB%B8%8C-%EC%97%B0%EB%8F%99)
## 📌 Git Commit Convention
본 프로젝트는 일관된 커밋 히스토리 관리와 가독성을 위해 **Conventional Commits** 규칙을 따릅니다. 모든 커밋 메시지는 아래 규칙을 준수하여 작성해 주세요.
### ✉️ 커밋 메시지 구조
커밋 메시지는 기본적으로 **제목, 본문, 바닥글** 구조를 가집니다. 본문과 바닥글은 필요한 경우에만 작성하며, 각 섹션은 **빈 줄**로 구분합니다.
```text
<Type>: <Subject>
<Body>
Footer
- Type: 작업의 종류를 나타내는 태그 (소문자로 작성)
- Subject: 변경 사항에 대한 간결한 요약 (50자 이내, 끝에 마침표 금지)
| Type | Description |
|---|---|
feat |
새로운 기능 추가 |
fix |
버그 수정 |
docs |
문서 수정 (README.md, 주석, 위키 등) |
style |
코드 포맷팅, 세미콜론 누락 등 (로직 변경 없는 경우) |
refactor |
코드 리팩토링 (기능 추가나 버그 수정이 없는 구조 개선) |
test |
테스트 코드 추가 및 수정 |
chore |
빌드 업무, 패키지 매니저 설정, 환경 설정 변경 등 |
design |
CSS 등 사용자 UI 디자인 변경 |
feat: 구글 소셜 로그인 기능 추가
설명이 길어서 헷갈리시는 분들은 아래 명령어만 VS Code 터미널(상단 Terminal -> New Terminal)에서 순서대로 복사해서 실행하시면 됩니다. (예시: 본인 이름이 홍길동인 경우)
# 1. 저장소 클론 및 폴더 이동
git clone https://github.com/Momentum-Research-Team/session-assignment.git
cd session-assignment
# 2. 본인 브랜치 생성 및 이동
git checkout -b feature/honggildong-test
# 3. 테스트 폴더로 이동하여 본인 폴더 생성
cd "3기 방학세션/테스트(06-18)"
mkdir 홍길동
cd 홍길동
# 4. 파일 생성 (직접 VS Code나 탐색기에서 '홍길동_테스트.ipynb' 파일을 생성하거나 드래그해서 넣으셔도 됩니다)
# 터미널에서 빈 파일 생성 시:
echo "" > 홍길동_테스트.ipynb
# 5. 최상위 폴더로 다시 이동 후 변경사항 추가
cd ../../../
git add "3기 방학세션/테스트(06-18)/홍길동/홍길동_테스트.ipynb"
# 6. 커밋
git commit -m "test: 홍길동 테스트 과제 제출"
# 7. 푸시
git push origin feature/honggildong-test*8. PR(Pull Request) 생성
- 푸시가 완료되면 GitHub 레포지토리에 접속합니다.
Pull requests탭에 들어가서 우측의New pull request초록색 버튼을 클릭합니다.- [중요] PR 브랜치 매칭 설정
PR 생성 화면 상단에서 브랜치가 다음과 같이 매칭되어 있는지 반드시 확인하세요!
👉
base: main<-compare: feature/honggildong-test(본인 브랜치) 이렇게 설정되어야 본인이 작업한 변경 사항이 제대로 뜨고 정상적으로 PR(Pull Requests)이 생성됩니다. - 확인 후 PR(Pull Requests)이 생성되면 초록색 버튼의 Merge를 누르시면 됩니다. (1주차부터는 Merge는 운영진에서 진행할 것인데 이번 테스트(06-18)은 Merge까지 진행해주시면 됩니다!)
- 제출 확인하기_테스트(06-18)
-
- 3기 방학세션 폴더 -> 테스트(06-18) 안으로 들어간다.
-
- 본인 이름 폴더가 생성된 것을 확인한다.
-
- 본인 이름 폴더 안에 본인이름_테스트.ipynb나 본인이름_테스트.py 파일이 보이면 성공.
-