Toolbox Aid

March 18th, 2026 5:27 PM Mr. Q Categories: github

Overview

This guide walks you step-by-step through creating your first Pull Request (PR) for your repo. You will:

• Create a new branch
• Update documentation files
• Commit your changes
• Push to GitHub
• Open a Pull Request

---

---

---

Option 1: Using VS Code (Recommended)

Step 1: Open Your Repository

• Open VS Code
• Go to File → Open Folder
• Select your repo:
  ToolboxAid/HTML-JavaScript-Gaming

---

Step 2: Create a New Branch

UI Method (easiest):

• Click the branch name (bottom-left corner)
• Select Create new branch
• Name it:

docs/engine-core-boundary

Terminal Method (optional):

git checkout -b docs/engine-core-boundary

---

Step 3: Create or Update Required Files

Create/update these files inside /docs/:

/docs/ENGINE_STANDARDS.md
/docs/ENGINE_API.md
/docs/reviews/architecture-review-v1.md
/docs/reviews/pr-roadmap.md

Paste the content from the PR plan (or generated content).

---

Step 4: Stage Changes

• Open Source Control panel (left sidebar)
• Click + next to each file or choose Stage All

---

Step 5: Commit Changes

Use this commit message:

docs(architecture): define engine/core runtime boundaries and public API

Click:

• ✅ Commit

---

Step 6: Push Your Branch

Click:

• Publish Branch

---

Step 7: Create Pull Request

• Click Create Pull Request
• Fill in:

Title:

docs(architecture): define engine/core runtime boundaries and public API

Description:
Use the PR description we generated earlier

• Click Create Pull Request

---

---

---

Option 2: Using GitHub Desktop (Simpler UI)

Step 1: Open Repository

• Open GitHub Desktop
• Select your repo

---

Step 2: Create a Branch

• Click branch dropdown
• Click New Branch
• Name:

docs/engine-core-boundary

---

Step 3: Edit Files

• Click Open in VS Code
• Make your doc changes

---

Step 4: Commit Changes

In GitHub Desktop:

Summary:

docs(architecture): define engine/core runtime boundaries and public API

Click:

• Commit to docs/engine-core-boundary

---

Step 5: Push Changes

Click:

• Push origin

---

Step 6: Create Pull Request

Click:

• Create Pull Request

Fill in title + description → Submit

---

---

---

Common Mistakes to Avoid

• Do NOT commit directly to main
• Do NOT include unrelated files
• Keep this PR docs-only (no code changes)

---

Summary

You now have a complete workflow:

1. Create branch
2. Edit docs
3. Commit
4. Push
5. Open PR

This is your first structured architecture PR, and it sets the foundation for all future improvements.