git-onboarding 가이드
git-onboarding은 Git을 처음 사용하는 분을 위한 시작 가이드입니다.
Git 설치부터 Pull Request(PR) 생성까지, 총 10단계를 하나씩 안내합니다. 어려운 설정도 질문에 답하기만 하면 자동으로 진행됩니다.
먼저 알아야 할 것들
- Git: 코드의 변경 이력을 기록하는 도구입니다. "누가, 언제, 무엇을 바꿨는지" 전부 추적됩니다. 실수했을 때 이전 버전으로 돌아갈 수도 있습니다.
- GitHub: Git으로 관리하는 코드를 인터넷에 올려서 저장하고 공유하는 서비스입니다. 다른 사람과 함께 작업할 때 꼭 필요합니다.
- 저장소(repository): 하나의 프로젝트 폴더라고 생각하세요. 코드와 변경 이력이 모두 들어있습니다.
- SSH 키: 내 컴퓨터와 GitHub 사이의 "신분증" 같은 것입니다. 매번 비밀번호를 입력하는 대신 이 키로 자동 인증됩니다.
- 커밋(commit): 작업 내용을 저장하는 것입니다. 게임의 "세이브 포인트"와 비슷합니다. 언제든 이 시점으로 돌아올 수 있습니다.
- push: 내 컴퓨터에 저장된 커밋을 GitHub에 올리는 것입니다.
- PR (Pull Request): "이 변경사항을 합쳐주세요"라는 요청입니다. 다른 사람이 내 코드를 검토하고 승인하면 합쳐집니다.
사용 가능한 명령어
이 플러그인에서 사용할 수 있는 명령어는 4개입니다:
/git-onboarding-auto — 완전 자동화 (설정 ~ PR)
Git 설정부터 파일 생성, 브랜치, 커밋, push, PR 생성까지 전 과정을 한 번에 자동으로 실행합니다. 이미 완료된 단계는 건너뛰고, 꼭 필요한 것만 질문합니다. "전부 자동으로 해줘", "원클릭 PR" 같은 요청에 사용하세요.
/git-onboarding-setup — 초기 설정 진행
Git과 GitHub를 사용하기 위한 기본 설정을 단계별로 해줍니다. 이미 끝난 단계는 자동으로 건너뛰므로, 중간부터 이어서 할 수도 있습니다.
9단계로 구성되어 있습니다:
단계 1. Git 설치 확인 컴퓨터에 Git이 설치되어 있는지 확인합니다.
단계 2. 사용자 이름 설정 커밋할 때 "이 코드를 누가 작성했는지" 표시되는 이름입니다.
단계 3. 이메일 설정 GitHub가 커밋과 계정을 연결하는 데 사용하는 이메일입니다.
단계 4. GitHub CLI 설치 GitHub와 연동하기 위한 명령어 도구(gh)를 설치합니다.
단계 5. GitHub 로그인 gh CLI로 GitHub에 로그인합니다.
단계 6. 저장소 준비 작업할 프로젝트를 준비합니다 (clone 또는 init).
단계 7. GitHub 원격 저장소 연결 GitHub에 저장소를 만들고 로컬과 연결합니다.
단계 8. 원격 브랜치 초기화 첫 커밋을 push하여 GitHub에 main 브랜치를 생성합니다.
단계 9. Git hooks 설치 main 브랜치 보호 + conventional commits 검증 hook을 설치합니다.
/git-onboarding-workflow — 다음 단계 안내
현재 git 상태를 분석하고 GitHub Flow 기준으로 다음에 할 일을 안내합니다. "지금 뭘 해야 하지?" 싶을 때 사용하세요.
/git-onboarding-step — 진행 상황 확인
설치부터 PR 생성까지 전체 10단계의 진행 상황을 보여줍니다. 현재 상태를 자동으로 감지하여 뭐가 끝났고 뭐가 남았는지 체크리스트로 알려줍니다.
이렇게 보입니다:
Git 시작하기 — 현재 진행 상황
[x] 1. Git 설치
[x] 2. 사용자 이름 설정 (홍길동)
[x] 3. 이메일 설정 (user@email.com)
[x] 4. SSH 키 생성
[ ] 5. GitHub SSH 연결 <-- 현재 단계
[ ] 6. 저장소 준비
[ ] 7. 브랜치 생성
[ ] 8. 첫 번째 커밋
[ ] 9. Push
[ ] 10. Pull Request 생성[x]는 완료, []는 아직 안 한 것, 화살표(<--)가 지금 해야 할 단계입니다.
전체 흐름 한눈에 보기
설정 (1~9) — /git-onboarding-setup이 안내
| 단계 | 뭘 하나요? | 왜 필요한가요? |
|---|---|---|
| 1 | Git 설치 | Git은 모든 작업의 기반 도구입니다 |
| 2 | 이름 설정 | 커밋에 "누가 했는지" 기록됩니다 |
| 3 | 이메일 설정 | GitHub가 커밋과 계정을 연결합니다 |
| 4 | GitHub CLI 설치 | GitHub와 연동하는 명령어 도구입니다 |
| 5 | GitHub 로그인 | push/pull을 하려면 인증이 필요합니다 |
| 6 | 저장소 준비 | 작업할 프로젝트 폴더를 만듭니다 |
| 7 | 원격 저장소 연결 | GitHub에 저장소를 만들고 연결합니다 |
| 8 | 첫 push | GitHub에 main 브랜치를 생성합니다 |
| 9 | Git hooks 설치 | main 보호 + 커밋 메시지 검증을 설정합니다 |
작업 — /git-onboarding-workflow가 안내
setup이 끝나면 /git-onboarding-workflow로 브랜치 생성 → 커밋 → push → PR까지 안내받을 수 있습니다.
추천 사용 순서
처음 시작하는 분은 이 순서로 진행하세요:
/git-onboarding-auto— 설정부터 PR까지 한 번에 자동으로 진행합니다 (추천)/git-onboarding-setup— 설정만 단계별로 진행합니다/git-onboarding-workflow— 설정이 끝나면 실제 작업을 안내받습니다/git-onboarding-step— 언제든 현재 진행 상황을 확인합니다
자주 묻는 질문
Q: Git을 한 번도 써본 적 없습니다. 어디서 시작하나요? A: /git-onboarding-setup을 입력하세요. Git이 설치되어 있는지부터 확인하고, 하나씩 차근차근 안내합니다. 어려운 명령어는 자동으로 실행해주고, 선택이 필요한 부분만 질문합니다.
Q: 어디까지 했는지 기억이 안 납니다 A: /git-onboarding-step을 입력하세요. 자동으로 현재 상태를 감지해서 뭐가 끝났고 뭐가 남았는지 체크리스트로 보여줍니다.
Q: SSH 키가 뭔가요? 어렵지 않나요? A: SSH 키는 내 컴퓨터와 GitHub 사이의 "신분증"입니다. 비밀번호를 매번 입력하는 대신, 이 키가 자동으로 "나 맞아요"라고 인증해줍니다. /git-onboarding-setup이 키 생성부터 GitHub 등록까지 전부 안내하니 걱정하지 마세요.
Q: noreply 이메일이 뭔가요? A: GitHub가 제공하는 비공개 이메일 주소입니다. 커밋 기록에 개인 이메일 대신 username@users.noreply.github.com 형식이 표시됩니다. GitHub 잔디(contribution)도 정상적으로 심어집니다. GitHub > Settings > Emails에서 확인할 수 있습니다.
Q: 설정(setup)이 다 끝났는데 다음에 뭘 하나요? A: /git-onboarding-workflow를 입력하세요. 브랜치 만들기, 커밋, push, PR 생성까지 현재 상태에 맞게 다음 단계를 안내합니다.
Q: clone과 init의 차이가 뭔가요? A: 둘 다 프로젝트를 시작하는 방법입니다.
- clone: GitHub에 이미 있는 프로젝트를 내 컴퓨터에 복사합니다. 다른 사람이 만든 프로젝트에 참여하거나, 내가 GitHub에서 먼저 만든 프로젝트를 가져올 때 사용합니다.
- init: 내 컴퓨터에 있는 폴더를 새 Git 프로젝트로 만듭니다. 처음부터 새로 시작할 때 사용합니다.
Q: 잔디(contribution)가 안 심어집니다 A: Git 이메일 설정이 GitHub 계정 이메일과 같은지 확인하세요. /git-onboarding-step을 실행하면 현재 설정된 이메일을 확인할 수 있습니다. 다르다면 /git-onboarding-setup으로 이메일을 다시 설정하세요.