Build Family Hoppe personal library with accounts, budget, projects, and guides
Agent-Logs-Url: https://github.com/donnyandjoern-debug/personal/sessions/93826564-9b2d-4153-87ef-aff93b139427 Co-authored-by: donnyandjoern-debug <262665187+donnyandjoern-debug@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
co-authored by
donnyandjoern-debug
donnyandjoern-debug
parent
e84b8be9a9
commit
7399617788
@@ -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)
|
||||
@@ -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)
|
||||
@@ -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)
|
||||
Reference in New Issue
Block a user
