git-onboarding is a getting-started guide for people using Git for the first time.
From installing Git to creating a Pull Request (PR), it guides you through a total of 10 steps one by one. Even difficult setup proceeds automatically just by answering questions.
Things you need to know first
- Git: It is a tool that records the history of code changes. Everything about "who, when, and what changed" is tracked. If you make a mistake, you can also go back to a previous version.
- GitHub: It is a service that stores and shares code managed with Git by uploading it to the internet. It is essential when working together with others.
- Repository: Think of it as a single project folder. It contains both the code and the change history.
- SSH 키: It is like an "ID card" between your computer and GitHub. Instead of entering your password every time, this key authenticates you automatically.
- Commit: It means saving your work. It is similar to a "save point" in a game. You can return to this point at any time.
- push: It means uploading commits saved on your computer to GitHub.
- PR (Pull Request): It is a request saying, "Please merge these changes." Once someone else reviews and approves your code, it is merged.
Available commands
There are 4 commands available in this plugin:
/git-onboarding-auto — fully automated (setup to PR)
It automatically runs the entire process at once, from Git setup to file creation, branch, commit, push, and PR creation. It skips steps that are already complete and asks only for what is absolutely necessary. Use it for requests like "do everything automatically" or "one-click PR".
/git-onboarding-setup — proceed with initial setup
It walks you step by step through the basic setup for using Git and GitHub. Since steps that are already complete are skipped automatically, you can also continue from the middle.
It consists of 9 steps:
Step 1. Check Git installation Check whether Git is installed on your computer.
Step 2. Set username This is the name shown when committing to indicate "who wrote this code."
Step 3. Set email This is the email GitHub uses to connect commits with your account.
Step 4. Install GitHub CLI Install the command-line tool (gh) for integrating with GitHub.
Step 5. Log in to GitHub Log in to GitHub with the gh CLI.
Step 6. Prepare repository Prepare the project you will work on (clone or init).
Step 7. Connect GitHub remote repository Create a repository on GitHub and connect it to your local machine.
Step 8. Initialize the remote branch Push the first commit to create the main branch on GitHub.
Step 9. Install Git hooks Install hooks for main branch protection + conventional commits validation.
/git-onboarding-workflow — guide to the next step
Analyze the current git status and guide you on what to do next based on GitHub Flow. Use this when you wonder, "What should I do now?"
/git-onboarding-step — check progress
Show the progress of all 10 steps from installation to PR creation. It automatically detects the current state and tells you what's done and what's left as a checklist.
It looks like this:
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]means completed, [ ]means not done yet, and the arrow (<--) is the step you should do now.
Full workflow at a glance
Setup (1–9) — guided by /git-onboarding-setup
| Step | What do you do? | Why is it needed? |
|---|---|---|
| 1 | Install Git | Git is the foundational tool for all your work |
| 2 | Set your name | "Who did it" is recorded in commits |
| 3 | Set your email | GitHub links commits to your account |
| 4 | Install GitHub CLI | It's a command-line tool that integrates with GitHub |
| 5 | Log in to GitHub | Authentication is required to push/pull |
| 6 | Prepare a repository | Create a project folder to work in |
| 7 | Connect the remote repository | Create a repository on GitHub and connect it |
| 8 | 첫 push | Create the main branch on GitHub |
| 9 | Install Git hooks | Set up main protection + commit message validation |
Work — guided by /git-onboarding-workflow
Once setup is done, /git-onboarding-workflowyou can get guidance from creating a branch → commit → push → PR.
Recommended order of use
If you're just starting out, proceed in this order:
/git-onboarding-auto— automatically proceeds from setup to PR all at once (recommended)/git-onboarding-setup— proceeds through setup only, step by step/git-onboarding-workflow— once setup is done, you get guidance for actual work/git-onboarding-step— check the current progress at any time
Frequently asked questions
Q: I've never used Git before. Where do I start?
A: /git-onboarding-setup. It first checks whether Git is installed and guides you step by step, one thing at a time. It automatically runs difficult commands and only asks questions where a choice is needed.
Q: I don't remember how far I've gotten
A: /git-onboarding-step. It automatically detects the current state and shows you what's done and what's left as a checklist.
Q: What is an SSH key? Isn't it difficult?
A: An SSH key is the "ID card" between my computer and GitHub.
Instead of entering a password every time, this key automatically authenticates "It's me."
/git-onboarding-setupDon't worry, as we guide you through everything from generating this key to registering it with GitHub.
Q: What is a noreply email?
A: It is a private email address provided by GitHub.
In commit history, instead of your personal email, username@users.noreply.github.com format is displayed.
GitHub grass (contribution) is also planted normally.
You can check it in GitHub > Settings > Emails.
Q: Setup is all done, what do I do next?
A: /git-onboarding-workflowEnter . We guide you through the next steps according to your current state, from creating a branch, committing, pushing, to creating a PR.
Q: What is the difference between clone and init? A: Both are ways to start a project.
- clone: Copies a project that already exists on GitHub to my computer. It is used when participating in a project someone else made, or when bringing in a project I first created on GitHub.
- init: Makes a folder on my computer into a new Git project. It is used when starting fresh from the beginning.
Q: The grass (contribution) is not being planted
A: Check whether the Git email setting is the same as your GitHub account email.
/git-onboarding-stepRunning lets you check the currently configured email.
If it is different, /git-onboarding-setupReconfigure the email with .