From 3fd400dd3c6c37c7890c8f6aeb22564c546a821c Mon Sep 17 00:00:00 2001
From: Oliver Cabral <82325590+Kymkim@users.noreply.github.com>
Date: Mon, 18 Aug 2025 19:29:37 -0700
Subject: [PATCH] Create CONTRIBUTING.md

---
 CONTRIBUTING.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..5a310b77
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,24 @@
+## Repo Structure
+```
+├─firmware/ - Embedded code for the core system
+├─hardware/ - Schematics and PCB layouts
+├─software/ - Host tools (keymap editor, etc.) (not yet implemented - soon hopefully!)
+├─docs/ - Design notes, communication protocol, build guides
+└─assets/ - Renders, diagrams, and media
+```
+
+## Branch Structure
+```
+main              # Stable, production-ready code (only tested & reviewed changes go here)
+│
+├─ dev            # Integration branch for features; "staging" area before merging to main
+│  ├─ software-xxxxxx     # New features, experiments, improvements, or PCB uploads    
+|  ├─ firmware-xxxxxx     # Please indicate in the branch the wether if its software
+│  └─ hardware-xxxxxx     # firmware, or hardware
+│
+├─ hotfix/        # Quick fixes for urgent bugs in main
+│   └─ hotfix/usb-detection
+│
+└─ docs/          # Documentation updates
+    └─ docs/protocol-update
+```