AI 공부 일기장

🔥 Commit Message 작성 방법
1. 커밋메시지 제목만 필요한지, 본문이 필요한지 구분
2. 본문에는 추가 or 변경 내용과 이유를 적는다.
    2.1. 무엇을 추가 or 변경했는지와 그 이유를 적는다.
    2.2. '어떻게’는 지양한다.

# git commit -m "<태크>: <설명>"
# <설명>  -> 가능하면 영문으로작성 지향, 필수는X -> 파파고돌리느라 시간쏟지마셈!!

git commit -m "init: Django 프로젝트 초기 설정"
git commit -m "gitignore: .gitignore 파일 설정"
git commit -m "add: users 앱 생성 및 설정 추가"
git commit -m "chore: settings.py에 AUTH_USER_MODEL 설정 추가"
git commit -m "feat: CustomUser 모델 추가"
git commit -m "migration: 초기 마이그레이션 파일 생성"
git commit -m "fix: 회원가입 API 구현 코드 변경"
git commit -m "chore: CORS 설정 추가"
git commit -m "chore: DEBUG 모드를 False로 변경"
git commit -m "docs: README.md 업데이트"

⚡️ Git 기본 Rules

1. main 브랜치는 직접 수정하지 않는다.

• main 브랜치는 배포용 브랜치이므로, 직접 수정하지 않고 항상 기능별 브랜치에서 작업해야 합니다.

2. 기능별 브랜치 생성(작업 브랜치 만들기)

• main 브랜치를 기반으로 기능별 브랜치를 만듭니다.

git switch -c 브랜치명

3. 기능 개발 후 커밋 & 원격 저장소로 push (작업 브랜치)

git add .   
# git add 후 status 꼭 확인하기!
git status
git commit -m "메세지"

또는 

git commit 후 vi 편집기 이용해서 커밋메세지 적기
git push

4. 최신 main을 반영하기 위해 pull (main 브랜치)

git switch main
git pull

5. main 브랜치의 변경 사항을 내 작업 브랜치에 병합

git switch 작업 브랜치
git merge main

6. 충돌(Conflict) 해결 후 commit

conflict 해결 후 
git status
git add .   
git commit 
git push

7. Pull Request(PR) 요청 (GitHub/GitLab)

• github에서 요청, 다른 팀원의 수락 후 머지 완료

플로우차트(Flowchart)란?

🌊 간단히 말해서는 순서도, 흐름도를 의미합니다.

🌊 프로세스를 수행하기 위해 필요한 일련의 단계와 결정을 시각적으로 표현한 자료입니다.

🌊 각각의 단계는 다이어그램 도형 안에 표현이 되며 진행 순서는 화살표를 이용하여 표현합니다.

🌊 이러한 플로우차트는 복잡한 프로세스를 명확하고 이해하기 쉬운 다이어그램으로 문서화하기 위해 사용됩니다.

Flowchart 기호

🌊 끝이 둥근 모양 : 시작점과 끝점

🌊 화살표 : 진행 순서

🌊 평행사변형 : 입출력 

🌊 직사각형 : 중간 단계

🌊 마름모 : 결정 단계(분기점)

Flowchart 그리기 Tip

1. 일관된 방향 유지

• 일반적으로 위→아래, 좌→우 방향으로 흐르게 구성하면 가독성이 좋아집니다.

2. 한눈에 이해 가능하도록 단순하게 작성

• 복잡한 흐름을 단순한 블록으로 나누는 게 좋습니다.
• 한 개의 차트에 너무 많은 정보를 넣지 않는 게 좋습니다.

3. 텍스트는 간결하게 기입

• 각 요소 안에 들어가는 텍스트는 짧고 명확하게 표현하는 게 좋습니다
  • 예) "데이터 입력" ❌, "입력" ⭕️

4. 긴 프로세스는 서브 차트를 활용

• 한 개의 차트에 너무 많은 정보를 넣기 보다는, 큰 흐름을 나누어 서브 차트로 만드는 게 좋습니다.

유용한 도구 추천

🛠 온라인 도구

• 🔗 draw.io (diagrams.net) – 무료 & 간편한 다이어그램 도구
• 🔗 Lucidchart – 협업 기능이 강력한 다이어그램 툴
• 🔗 Microsoft Visio – 기업용으로 많이 사용됨
• 🔗 Miro – 팀 협업 및 브레인스토밍에 적합
• 🔗 Whimsical – 직관적인 UI로 빠르게 다이어그램 작성 가능

🛠 코드 기반 도구 (자동 생성 가능)

• Mermaid.js – 마크다운 기반으로 코드로 다이어그램 작성 가능
• 🔗 PlantUML – UML 다이어그램을 코드로 생성하는 강력한 도구 (공식 문서 링크)