Merge pull request #1 from donnyandjoern-debug/copilot/create-family-hoppe-library
This commit is contained in:
donnyandjoern-debug
GitHub
commit
cbf47e1972
77
README.md
77
README.md
|
|
@ -1,2 +1,75 @@
|
||||||
# personal
|
# 🏠 Family Hoppe — Personal Library
|
||||||
personal repository for Family Hoppe
|
|
||||||
|
> **Central brain for Family Hoppe.** Instant access to accounts, budgets, projects, and GitHub knowledge — clean, professional, and precise.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📚 Quick Navigation
|
||||||
|
|
||||||
|
| Section | Description |
|
||||||
|
|---|---|
|
||||||
|
| [👥 Accounts](./accounts/README.md) | GitHub accounts overview (Family Hoppe & Joern) |
|
||||||
|
| [💰 Budget](./budget/README.md) | Membership costs & spending tracker |
|
||||||
|
| [📁 Projects](./projects/README.md) | All projects under Hoppe-home & personal |
|
||||||
|
| [📖 Guides](./guides/README.md) | Copilot, GitHub, and workflow quick-reference guides |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🧠 At a Glance
|
||||||
|
|
||||||
|
### GitHub Accounts
|
||||||
|
|
||||||
|
| Account | Role | Plan |
|
||||||
|
|---|---|---|
|
||||||
|
| [donnyandjoern-debug](https://github.com/donnyandjoern-debug) | **Family Hoppe main** — Mac / primary workspace | Copilot Pro ($10/mo) + $25/mo budget |
|
||||||
|
| Joern _(profile pending creation)_ | **Windows VS Code** — secondary workspace | Copilot Pro ($10/mo, planned) |
|
||||||
|
|
||||||
|
### Monthly Budget Summary
|
||||||
|
|
||||||
|
| Item | Cost |
|
||||||
|
|---|---|
|
||||||
|
| Copilot Pro — Family Hoppe main | $10 / month |
|
||||||
|
| Copilot Pro — Joern (planned) | $10 / month |
|
||||||
|
| GitHub budget (actions, packages, etc.) | $25 / month |
|
||||||
|
| **Total** | **$45 / month** |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🗂 Repository Structure
|
||||||
|
|
||||||
|
```
|
||||||
|
personal/
|
||||||
|
├── README.md ← You are here (main dashboard)
|
||||||
|
├── accounts/
|
||||||
|
│ ├── README.md ← Accounts overview
|
||||||
|
│ ├── family-hoppe.md ← donnyandjoern-debug account details
|
||||||
|
│ └── joern-hoppe.md ← Joern@Hoppe.home account details
|
||||||
|
├── budget/
|
||||||
|
│ ├── README.md ← Budget overview
|
||||||
|
│ └── tracking.md ← Monthly spend tracker
|
||||||
|
├── projects/
|
||||||
|
│ ├── README.md ← All projects index
|
||||||
|
│ └── hoppe-home.md ← Hoppe-home org projects
|
||||||
|
└── guides/
|
||||||
|
├── README.md ← Guides index
|
||||||
|
├── copilot.md ← GitHub Copilot tips & tricks
|
||||||
|
└── github-workflow.md ← GitHub workflow best practices
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🔍 Search Tips
|
||||||
|
|
||||||
|
GitHub's built-in search makes this library instantly searchable:
|
||||||
|
- Press **`t`** on any page to search files
|
||||||
|
- Press **`/`** to focus the global search bar
|
||||||
|
- Use `repo:donnyandjoern-debug/personal <keyword>` from any GitHub search
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ✅ Principles
|
||||||
|
|
||||||
|
1. **Personal data only** — all project code lives in [Hoppe-home](https://github.com/Hoppe-home)
|
||||||
|
2. **Clean & precise** — no clutter, everything has a place
|
||||||
|
3. **Both accounts supported** — brain and clean-up assistant for Family Hoppe and Joern
|
||||||
|
4. **Up-to-date** — update this library whenever memberships, projects, or budgets change
|
||||||
|
|
|
||||||
33
accounts/README.md
Normal file
33
accounts/README.md
Normal file
|
|
@ -0,0 +1,33 @@
|
||||||
|
# 👥 GitHub Accounts — Family Hoppe
|
||||||
|
|
||||||
|
Overview of all GitHub accounts used by Family Hoppe.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Accounts
|
||||||
|
|
||||||
|
| Account | Purpose | Details |
|
||||||
|
|---|---|---|
|
||||||
|
| [donnyandjoern-debug](./family-hoppe.md) | Main family account — Mac & primary Copilot workspace | [→ Details](./family-hoppe.md) |
|
||||||
|
| Joern _(account pending creation)_ | Secondary account — Windows VS Code workspace | [→ Details](./joern-hoppe.md) |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Organisation: Hoppe-home
|
||||||
|
|
||||||
|
All shared project code is kept under the **[Hoppe-home](https://github.com/Hoppe-home)** organisation.
|
||||||
|
This personal repository (`donnyandjoern-debug/personal`) is for personal data, reference notes, and the Family Hoppe knowledge base only.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Connecting Both Accounts
|
||||||
|
|
||||||
|
Both accounts collaborate on the same projects inside Hoppe-home:
|
||||||
|
|
||||||
|
1. Add `Joern@Hoppe.home` as a member of the Hoppe-home organisation.
|
||||||
|
2. Use GitHub Copilot on each account independently (each has its own Pro seat).
|
||||||
|
3. Reference [guides/copilot.md](../guides/copilot.md) for multi-account Copilot workflow tips.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
[← Back to main library](../README.md)
|
||||||
53
accounts/family-hoppe.md
Normal file
53
accounts/family-hoppe.md
Normal file
|
|
@ -0,0 +1,53 @@
|
||||||
|
# donnyandjoern-debug — Family Hoppe Main Account
|
||||||
|
|
||||||
|
## Identity
|
||||||
|
|
||||||
|
| Field | Value |
|
||||||
|
|---|---|
|
||||||
|
| GitHub username | `donnyandjoern-debug` |
|
||||||
|
| Role | Primary / family account |
|
||||||
|
| Primary device | Mac |
|
||||||
|
| Primary editor | VS Code (Mac) |
|
||||||
|
| Organisation | [Hoppe-home](https://github.com/Hoppe-home) |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Memberships & Plans
|
||||||
|
|
||||||
|
| Plan | Cost | Notes |
|
||||||
|
|---|---|---|
|
||||||
|
| GitHub Free (base) | $0 / month | Unlimited public repos, 2,000 Actions minutes/month |
|
||||||
|
| **Copilot Pro** | **$10 / month** | AI code completion, chat, agents |
|
||||||
|
| **GitHub budget** | **$25 / month** | Extra Actions minutes, Packages storage, Codespaces, etc. |
|
||||||
|
| **Total** | **$35 / month** | |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Repositories
|
||||||
|
|
||||||
|
| Repo | Description |
|
||||||
|
|---|---|
|
||||||
|
| [personal](https://github.com/donnyandjoern-debug/personal) | This library — personal data & Family Hoppe brain |
|
||||||
|
|
||||||
|
> All project repositories live under the **[Hoppe-home](https://github.com/Hoppe-home)** organisation.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Copilot Usage
|
||||||
|
|
||||||
|
- ✅ Copilot Pro active
|
||||||
|
- Used in VS Code on Mac as the primary AI assistant
|
||||||
|
- Copilot Coding Agent (cloud agent) enabled for autonomous issue resolution
|
||||||
|
- See [guides/copilot.md](../guides/copilot.md) for tips
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
- This account is the **owner** of the Hoppe-home organisation.
|
||||||
|
- Budget of $25/month covers GitHub Actions minutes and storage beyond the free tier.
|
||||||
|
- No corporate GitHub membership yet (planned for future).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
[← Back to accounts](./README.md) | [← Back to main library](../README.md)
|
||||||
55
accounts/joern-hoppe.md
Normal file
55
accounts/joern-hoppe.md
Normal file
|
|
@ -0,0 +1,55 @@
|
||||||
|
# Joern (Windows VS Code Account) — Planned
|
||||||
|
|
||||||
|
## Identity
|
||||||
|
|
||||||
|
| Field | Value |
|
||||||
|
|---|---|
|
||||||
|
| GitHub username | _(to be decided — must use alphanumeric characters and hyphens only, e.g. `joern-hoppe`)_ |
|
||||||
|
| Role | Secondary / Windows workspace account |
|
||||||
|
| Primary device | Windows PC |
|
||||||
|
| Primary editor | VS Code (Windows) |
|
||||||
|
| Organisation | [Hoppe-home](https://github.com/Hoppe-home) |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Memberships & Plans
|
||||||
|
|
||||||
|
| Plan | Cost | Status | Notes |
|
||||||
|
|---|---|---|---|
|
||||||
|
| GitHub Free (base) | $0 / month | Active | Unlimited public repos |
|
||||||
|
| **Copilot Pro** | **$10 / month** | 🟡 Planned | To be activated for Windows VS Code workflow |
|
||||||
|
| **Total** | **$10 / month** | Planned | |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
This account is the dedicated Windows workspace for Joern, used alongside the main Family Hoppe account:
|
||||||
|
|
||||||
|
- Work on the same Hoppe-home projects from a Windows PC
|
||||||
|
- Use GitHub Copilot Pro independently on Windows VS Code
|
||||||
|
- Collaborate with `donnyandjoern-debug` inside the Hoppe-home organisation
|
||||||
|
- Keep code clean, professional, and precise across both machines
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Setup Checklist
|
||||||
|
|
||||||
|
- [ ] Create the GitHub account for `Joern@Hoppe.home`
|
||||||
|
- [ ] Activate Copilot Pro ($10/month)
|
||||||
|
- [ ] Add account to the Hoppe-home organisation
|
||||||
|
- [ ] Configure VS Code on Windows with GitHub Copilot extension
|
||||||
|
- [ ] Sign in to VS Code with the Joern account
|
||||||
|
- [ ] Test Copilot completion and chat in VS Code (Windows)
|
||||||
|
- [ ] Connect to Hoppe-home projects and verify access
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
- This account should **not** be the owner of Hoppe-home — keep it as a member.
|
||||||
|
- Personal data for this account can be stored in a separate `personal` repo under this account if needed.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
[← Back to accounts](./README.md) | [← Back to main library](../README.md)
|
||||||
47
budget/README.md
Normal file
47
budget/README.md
Normal file
|
|
@ -0,0 +1,47 @@
|
||||||
|
# 💰 Budget — Family Hoppe
|
||||||
|
|
||||||
|
Overview of all GitHub-related spending for Family Hoppe.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Monthly Budget Summary
|
||||||
|
|
||||||
|
| Item | Account | Cost | Status |
|
||||||
|
|---|---|---|---|
|
||||||
|
| Copilot Pro | donnyandjoern-debug (Mac) | $10 / month | ✅ Active |
|
||||||
|
| Copilot Pro | Joern _(account pending creation)_ | $10 / month | 🟡 Planned |
|
||||||
|
| GitHub budget (Actions, Packages, Codespaces) | donnyandjoern-debug | $25 / month | ✅ Active |
|
||||||
|
| GitHub Enterprise / Corporate membership | — | TBD | 🔲 Not yet |
|
||||||
|
| **Total (current)** | | **$35 / month** | |
|
||||||
|
| **Total (when Joern active)** | | **$45 / month** | |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Budget Breakdown
|
||||||
|
|
||||||
|
### GitHub Copilot Pro — $10/month per seat
|
||||||
|
- AI code completion in VS Code
|
||||||
|
- Copilot Chat (ask questions about code)
|
||||||
|
- Copilot Coding Agent (autonomous issue resolution in the browser)
|
||||||
|
- Copilot CLI, PR summaries, and more
|
||||||
|
|
||||||
|
### GitHub Budget — $25/month
|
||||||
|
Used for:
|
||||||
|
- **GitHub Actions** minutes beyond the free 2,000 min/month (public repos are free)
|
||||||
|
- **GitHub Packages** storage beyond the free tier
|
||||||
|
- **Codespaces** usage (cloud dev environments)
|
||||||
|
- **GitHub Models** API calls if used beyond free quota
|
||||||
|
|
||||||
|
### Future: Corporate Membership
|
||||||
|
- No corporate membership yet
|
||||||
|
- Will consider when project scale requires it (e.g., GitHub Advanced Security, Enterprise SSO)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Spend Tracker
|
||||||
|
|
||||||
|
See [tracking.md](./tracking.md) for a month-by-month record.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
[← Back to main library](../README.md)
|
||||||
43
budget/tracking.md
Normal file
43
budget/tracking.md
Normal file
|
|
@ -0,0 +1,43 @@
|
||||||
|
# 📊 Monthly Spend Tracker — Family Hoppe
|
||||||
|
|
||||||
|
Track actual GitHub spending month by month.
|
||||||
|
|
||||||
|
> **Update this file** at the start of each month with the previous month's actual spend.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## How to Check Your GitHub Spend
|
||||||
|
|
||||||
|
1. Go to **GitHub.com → Settings → Billing and plans**
|
||||||
|
2. Check "Usage this month" for Actions, Packages, and Codespaces
|
||||||
|
3. Check invoices under "Payment history"
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Tracker
|
||||||
|
|
||||||
|
| Month | Copilot Pro (Donny) | Copilot Pro (Joern) | GitHub Budget Used | GitHub Budget Limit | Notes |
|
||||||
|
|---|---|---|---|---|---|
|
||||||
|
| April 2026 | $10 | — | — | $25 | First tracking month |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Targets
|
||||||
|
|
||||||
|
| Goal | Target |
|
||||||
|
|---|---|
|
||||||
|
| Stay within GitHub budget | ≤ $25 / month |
|
||||||
|
| Activate Joern Copilot Pro | When Windows VS Code setup is complete |
|
||||||
|
| Review corporate membership need | Quarterly |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
- If GitHub Actions usage approaches $20/month, review which workflows are consuming the most minutes.
|
||||||
|
- Public repository Actions minutes are **free** — keep projects public where possible.
|
||||||
|
- Codespaces can be expensive; prefer local VS Code where possible.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
[← Back to budget overview](./README.md) | [← Back to main library](../README.md)
|
||||||
25
guides/README.md
Normal file
25
guides/README.md
Normal file
|
|
@ -0,0 +1,25 @@
|
||||||
|
# 📖 Guides — Family Hoppe
|
||||||
|
|
||||||
|
Quick-reference guides for GitHub, Copilot, and the Family Hoppe workflow.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Available Guides
|
||||||
|
|
||||||
|
| Guide | Description |
|
||||||
|
|---|---|
|
||||||
|
| [GitHub Copilot](./copilot.md) | Copilot tips, shortcuts, and multi-account workflow |
|
||||||
|
| [GitHub Workflow](./github-workflow.md) | Branching, PRs, issues, and clean repo practices |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Principles for Family Hoppe
|
||||||
|
|
||||||
|
1. **Clean** — No clutter. Archive or delete repos that are no longer needed.
|
||||||
|
2. **Professional** — Meaningful commit messages, good READMEs, proper branching.
|
||||||
|
3. **Precise** — Do the right thing the first time. Use Copilot to help but always review.
|
||||||
|
4. **Consistent** — Same workflow on Mac (donnyandjoern-debug) and Windows (Joern@Hoppe.home).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
[← Back to main library](../README.md)
|
||||||
119
guides/copilot.md
Normal file
119
guides/copilot.md
Normal file
|
|
@ -0,0 +1,119 @@
|
||||||
|
# 🤖 GitHub Copilot Guide — Family Hoppe
|
||||||
|
|
||||||
|
Quick reference for getting the most out of GitHub Copilot across both Family Hoppe accounts.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Accounts & Plans
|
||||||
|
|
||||||
|
| Account | Plan | Editor | Status |
|
||||||
|
|---|---|---|---|
|
||||||
|
| donnyandjoern-debug | Copilot Pro ($10/mo) | VS Code (Mac) | ✅ Active |
|
||||||
|
| Joern _(account pending creation)_ | Copilot Pro ($10/mo) | VS Code (Windows) | 🟡 Planned |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Copilot Features (Pro Plan)
|
||||||
|
|
||||||
|
| Feature | Description | Where |
|
||||||
|
|---|---|---|
|
||||||
|
| **Code completion** | Inline AI suggestions as you type | VS Code editor |
|
||||||
|
| **Copilot Chat** | Ask questions about code, get explanations | VS Code sidebar / inline |
|
||||||
|
| **Copilot Edits** | Multi-file AI edits for larger changes | VS Code |
|
||||||
|
| **Copilot Coding Agent** | Autonomous agent that solves GitHub issues | GitHub.com (browser) |
|
||||||
|
| **PR summaries** | Auto-generated pull request descriptions | GitHub.com |
|
||||||
|
| **Copilot CLI** | AI-powered terminal suggestions | Terminal / shell |
|
||||||
|
| **GitHub Models** | Access to AI models via the API | GitHub Marketplace |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## VS Code Setup
|
||||||
|
|
||||||
|
### Install Copilot in VS Code
|
||||||
|
|
||||||
|
1. Open VS Code
|
||||||
|
2. Go to Extensions (`Ctrl+Shift+X` / `Cmd+Shift+X`)
|
||||||
|
3. Search for **"GitHub Copilot"** and install it
|
||||||
|
4. Also install **"GitHub Copilot Chat"**
|
||||||
|
5. Sign in with your GitHub account when prompted
|
||||||
|
|
||||||
|
### Key Shortcuts (VS Code)
|
||||||
|
|
||||||
|
| Action | Mac | Windows |
|
||||||
|
|---|---|---|
|
||||||
|
| Accept suggestion | `Tab` | `Tab` |
|
||||||
|
| Dismiss suggestion | `Esc` | `Esc` |
|
||||||
|
| Next suggestion | `Alt+]` | `Alt+]` |
|
||||||
|
| Previous suggestion | `Alt+[` | `Alt+[` |
|
||||||
|
| Open Copilot Chat | `Ctrl+Cmd+I` | `Ctrl+Alt+I` |
|
||||||
|
| Inline chat | `Cmd+I` | `Ctrl+I` |
|
||||||
|
| Open Copilot Edits | `Ctrl+Shift+I` | `Ctrl+Shift+I` |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Copilot Coding Agent (Cloud Agent)
|
||||||
|
|
||||||
|
The Copilot Coding Agent lets Copilot autonomously work on GitHub issues:
|
||||||
|
|
||||||
|
1. Go to a GitHub Issue in your browser
|
||||||
|
2. Click **"Assign to Copilot"** (or mention `@github-copilot` in a comment)
|
||||||
|
3. Copilot opens a PR with the solution
|
||||||
|
4. Review the PR, request changes if needed, and merge
|
||||||
|
|
||||||
|
**Tips:**
|
||||||
|
- Write clear, detailed issue descriptions — the agent works from the issue text.
|
||||||
|
- The agent works best on well-scoped, single-concern issues.
|
||||||
|
- Always review the agent's PR before merging.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Multi-Account Workflow
|
||||||
|
|
||||||
|
When working across both accounts (Mac + Windows):
|
||||||
|
|
||||||
|
1. Each account has its own Copilot Pro subscription — they work independently.
|
||||||
|
2. Both accounts can collaborate on the same Hoppe-home organisation repos.
|
||||||
|
3. Copilot suggestions are personal — they do not sync between accounts.
|
||||||
|
4. Use GitHub Issues and PRs to hand off work between accounts.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Useful Copilot Chat Prompts
|
||||||
|
|
||||||
|
```
|
||||||
|
# Explain code
|
||||||
|
/explain
|
||||||
|
|
||||||
|
# Fix a bug
|
||||||
|
/fix
|
||||||
|
|
||||||
|
# Generate tests
|
||||||
|
/tests
|
||||||
|
|
||||||
|
# Create documentation
|
||||||
|
/doc
|
||||||
|
|
||||||
|
# Simplify code
|
||||||
|
Simplify this function and reduce duplication
|
||||||
|
|
||||||
|
# Review a PR
|
||||||
|
Review this pull request for security issues and code quality
|
||||||
|
|
||||||
|
# Clean up a repo
|
||||||
|
What files in this repo are redundant or should be removed?
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Best Practices
|
||||||
|
|
||||||
|
- ✅ Always review Copilot suggestions before accepting
|
||||||
|
- ✅ Use Copilot Chat to understand unfamiliar code
|
||||||
|
- ✅ Use the Coding Agent for well-defined GitHub issues
|
||||||
|
- ✅ Write good commit messages — Copilot can help with these too
|
||||||
|
- ❌ Don't accept suggestions blindly — Copilot can hallucinate
|
||||||
|
- ❌ Don't use Copilot to generate secrets, passwords, or credentials
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
[← Back to guides](./README.md) | [← Back to main library](../README.md)
|
||||||
146
guides/github-workflow.md
Normal file
146
guides/github-workflow.md
Normal file
|
|
@ -0,0 +1,146 @@
|
||||||
|
# 🔀 GitHub Workflow Guide — Family Hoppe
|
||||||
|
|
||||||
|
Best practices for clean, professional GitHub work across all Family Hoppe projects.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Branch Strategy
|
||||||
|
|
||||||
|
Use a simple **feature-branch workflow**:
|
||||||
|
|
||||||
|
```
|
||||||
|
main ← stable, always deployable
|
||||||
|
└── feature/short-description ← your working branch
|
||||||
|
└── fix/issue-description ← bug fix branch
|
||||||
|
└── docs/update-readme ← documentation update
|
||||||
|
```
|
||||||
|
|
||||||
|
**Rules:**
|
||||||
|
- Never commit directly to `main`
|
||||||
|
- Branch names: lowercase, hyphens only, descriptive (e.g., `feature/add-user-login`)
|
||||||
|
- Delete branches after merging
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Commit Messages
|
||||||
|
|
||||||
|
Follow the **Conventional Commits** format:
|
||||||
|
|
||||||
|
```
|
||||||
|
<type>: <short description>
|
||||||
|
|
||||||
|
[optional body]
|
||||||
|
[optional footer]
|
||||||
|
```
|
||||||
|
|
||||||
|
| Type | When to use |
|
||||||
|
|---|---|
|
||||||
|
| `feat:` | A new feature |
|
||||||
|
| `fix:` | A bug fix |
|
||||||
|
| `docs:` | Documentation changes only |
|
||||||
|
| `chore:` | Maintenance (deps, config, cleanup) |
|
||||||
|
| `refactor:` | Code restructuring without feature/fix |
|
||||||
|
| `test:` | Adding or updating tests |
|
||||||
|
|
||||||
|
**Examples:**
|
||||||
|
```
|
||||||
|
feat: add user authentication
|
||||||
|
fix: correct off-by-one error in pagination
|
||||||
|
docs: update README with installation steps
|
||||||
|
chore: update dependencies to latest versions
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Pull Request Checklist
|
||||||
|
|
||||||
|
Before opening a PR:
|
||||||
|
- [ ] Branch is up to date with `main`
|
||||||
|
- [ ] All tests pass
|
||||||
|
- [ ] Code has been reviewed (or Copilot Chat used to review)
|
||||||
|
- [ ] PR description explains what and why
|
||||||
|
- [ ] No secrets or credentials in the diff
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Issue Best Practices
|
||||||
|
|
||||||
|
Write issues that Copilot (and humans) can act on:
|
||||||
|
|
||||||
|
1. **Title:** Short and specific (e.g., "Add dark mode toggle to settings page")
|
||||||
|
2. **Description:** What should happen vs. what currently happens
|
||||||
|
3. **Acceptance criteria:** Bullet list of what "done" looks like
|
||||||
|
4. **Labels:** Use labels (`bug`, `feature`, `docs`, `chore`)
|
||||||
|
5. **Assignee:** Assign to yourself or to Copilot
|
||||||
|
|
||||||
|
**Good issue template:**
|
||||||
|
```markdown
|
||||||
|
## What
|
||||||
|
A clear description of the change needed.
|
||||||
|
|
||||||
|
## Why
|
||||||
|
Why is this needed? What problem does it solve?
|
||||||
|
|
||||||
|
## Acceptance Criteria
|
||||||
|
- [ ] Criterion 1
|
||||||
|
- [ ] Criterion 2
|
||||||
|
|
||||||
|
## Additional Context
|
||||||
|
Any links, screenshots, or related issues.
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Repo Hygiene
|
||||||
|
|
||||||
|
Keep repos clean and professional:
|
||||||
|
|
||||||
|
| Practice | Description |
|
||||||
|
|---|---|
|
||||||
|
| **README.md** | Every repo needs one — what is it, how to run it |
|
||||||
|
| **LICENSE** | Add a license (MIT for open source) |
|
||||||
|
| **.gitignore** | Always add a proper `.gitignore` |
|
||||||
|
| **Branch protection** | Protect `main` — require PR reviews |
|
||||||
|
| **Archive old repos** | Don't delete — archive when no longer active |
|
||||||
|
| **Descriptive names** | `hoppe-home/recipe-manager`, not `test123` |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## GitHub Search Shortcuts
|
||||||
|
|
||||||
|
| Shortcut | Action |
|
||||||
|
|---|---|
|
||||||
|
| `t` | Search files in the current repo |
|
||||||
|
| `/` | Focus global search |
|
||||||
|
| `g c` | Go to Code tab |
|
||||||
|
| `g i` | Go to Issues tab |
|
||||||
|
| `g p` | Go to Pull Requests tab |
|
||||||
|
| `?` | Show all keyboard shortcuts |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Useful GitHub CLI Commands
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Create a new branch and PR
|
||||||
|
gh pr create --title "feat: my feature" --body "Description here"
|
||||||
|
|
||||||
|
# View open PRs
|
||||||
|
gh pr list
|
||||||
|
|
||||||
|
# Check out a PR locally
|
||||||
|
gh pr checkout <number>
|
||||||
|
|
||||||
|
# View open issues
|
||||||
|
gh issue list
|
||||||
|
|
||||||
|
# Create an issue
|
||||||
|
gh issue create --title "bug: something is broken" --label "bug"
|
||||||
|
|
||||||
|
# View repo status
|
||||||
|
gh repo view
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
[← Back to guides](./README.md) | [← Back to main library](../README.md)
|
||||||
64
projects/README.md
Normal file
64
projects/README.md
Normal file
|
|
@ -0,0 +1,64 @@
|
||||||
|
# 📁 Projects — Family Hoppe
|
||||||
|
|
||||||
|
All project-related work lives under the **[Hoppe-home](https://github.com/Hoppe-home)** organisation.
|
||||||
|
This page is the master index of active, paused, and completed projects.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## How Projects Are Organised
|
||||||
|
|
||||||
|
```
|
||||||
|
Hoppe-home (organisation)
|
||||||
|
├── project-1/ ← Individual project repos
|
||||||
|
├── project-2/
|
||||||
|
└── ...
|
||||||
|
|
||||||
|
donnyandjoern-debug/personal ← This repo (personal data / brain only)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Rule:** Code → Hoppe-home. Personal notes/reference → this repo.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Active Projects
|
||||||
|
|
||||||
|
| Project | Repo | Description | Accounts |
|
||||||
|
|---|---|---|---|
|
||||||
|
| _(add projects here)_ | — | — | — |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Planned Projects
|
||||||
|
|
||||||
|
| Project | Description | Priority |
|
||||||
|
|---|---|---|
|
||||||
|
| _(add planned projects here)_ | — | — |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Completed Projects
|
||||||
|
|
||||||
|
| Project | Repo | Completed |
|
||||||
|
|---|---|---|
|
||||||
|
| _(add completed projects here)_ | — | — |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Project Guidelines
|
||||||
|
|
||||||
|
1. All project repos belong to [Hoppe-home](https://github.com/Hoppe-home), never to personal accounts.
|
||||||
|
2. Both `donnyandjoern-debug` and `Joern@Hoppe.home` should be members of Hoppe-home to collaborate.
|
||||||
|
3. Use GitHub Issues and Projects boards to track progress.
|
||||||
|
4. Keep repos clean: descriptive names, a good README, and a license.
|
||||||
|
5. Archive repos when a project is complete and no longer maintained.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Related
|
||||||
|
|
||||||
|
- [Hoppe-home org](./hoppe-home.md) — Organisation structure and members
|
||||||
|
- [Guides](../guides/README.md) — GitHub workflow best practices
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
[← Back to main library](../README.md)
|
||||||
47
projects/hoppe-home.md
Normal file
47
projects/hoppe-home.md
Normal file
|
|
@ -0,0 +1,47 @@
|
||||||
|
# 🏢 Hoppe-home Organisation
|
||||||
|
|
||||||
|
Details about the Hoppe-home GitHub organisation used for all Family Hoppe projects.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Organisation Details
|
||||||
|
|
||||||
|
| Field | Value |
|
||||||
|
|---|---|
|
||||||
|
| GitHub URL | [https://github.com/Hoppe-home](https://github.com/Hoppe-home) |
|
||||||
|
| Owner | `donnyandjoern-debug` (Family Hoppe main account) |
|
||||||
|
| Plan | Free organisation (project repos are public) |
|
||||||
|
| Purpose | All project code for Family Hoppe |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Members
|
||||||
|
|
||||||
|
| Member | Role | Account |
|
||||||
|
|---|---|---|
|
||||||
|
| donnyandjoern-debug | Owner | Family Hoppe main (Mac) |
|
||||||
|
| Joern _(account pending creation)_ | Member | Windows VS Code (to be added) |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Repositories
|
||||||
|
|
||||||
|
> Update this table when new repos are created in Hoppe-home.
|
||||||
|
|
||||||
|
| Repo | Description | Status |
|
||||||
|
|---|---|---|
|
||||||
|
| _(add repos here)_ | — | — |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Organisation Settings Checklist
|
||||||
|
|
||||||
|
- [ ] Set a profile picture / avatar for Hoppe-home
|
||||||
|
- [ ] Add a description and URL to the org profile
|
||||||
|
- [ ] Add `Joern@Hoppe.home` as a member once the account is created
|
||||||
|
- [ ] Enable branch protection on `main` for all repos
|
||||||
|
- [ ] Use GitHub Projects for project management
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
[← Back to projects](./README.md) | [← Back to main library](../README.md)
|
||||||
Loading…
Reference in New Issue
Block a user