The Engineering Standard for Version Control Excellence
A comprehensive, interactive reference guide designed to standardize Branching, Commits, and Collaboration workflows.
Confusion leads to conflicts. The Git Protocol Handbook serves as the Single Source of Truth for development teams. It transforms abstract Git concepts into a visual, interactive manual that answers the question: "How do we write code here?"
"Code is read much more often than it is written." — This handbook ensures the history of that code is just as readable.
| 🌟 Feature | ℹ️ Description |
|---|---|
| Interactive UI | Tab-based navigation built with vanilla JS for instant access to topics. |
| Visual Branching | Clear diagrams explaining main vs dev vs feature strategies. |
| Command Library | A "Copy-Paste" ready library of every Git command you'll ever need. |
| Semantic Guide | A reference table for Conventional Commits (feat, fix, chore). |
| Mobile Ready | Fully responsive design powered by Tailwind CSS. |
This project covers the Four Pillars of Git Excellence:
1. 🌿 Branching Strategy (Click to expand)
We follow a strict flow to ensure stability:
main: Production. Protected. Deployable.dev: Staging. Integration testing ground.feature/*: Temporary. Where work happens.
2. 💬 Semantic Commits (Click to expand)
No more git commit -m "fixed stuff". We use:
feat: New features.fix: Bug fixes.docs: Documentation only.refactor: Code change that neither fixes a bug nor adds a feature.
3. ⚔️ Conflict Resolution (Click to expand)
A step-by-step visual guide on reading diffs, understanding HEAD vs Incoming changes, and using VS Code tools to merge safely.
4. 📦 Monorepo Structure (Click to expand)
Standardized folder structures for full-stack applications, ensuring everyone knows exactly where frontend, backend, and config files belong.
This project is built to be lightweight, fast, and easy to deploy anywhere.
Semantic HTML5
Tailwind CSS (CDN)
Vanilla JS (ES6)
Run this handbook locally in 3 simple steps:
-
Clone the Repo
git clone https://github.com/Yashparmar1125/Github-Workflow
-
Navigate to Folder
cd Github-Workflow -
Launch! Simply open
index.htmlin your browser. Recommended: Use "Live Server" extension in VS Code.
We believe in Kaizen (continuous improvement). If you have a better way to Git, let us know!
- Fork the Project
- Create your Feature Branch (
git checkout -b feat/AmazingFeature) - Commit your Changes (
git commit -m 'feat: add some AmazingFeature') - Push to the Branch (
git push origin feat/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Made with ❤️ by the Yash Parmar