github-profile

Files (1)

• SKILL.md

SKILL.md (first lines)

# GitHub Profile Optimizer

This skill audits a GitHub profile and generates an optimized profile README along with recommendations for metadata, pinned repositories, and stats widgets. A strong GitHub profile is a developer's storefront — it shapes perception before anyone reads a line of code.

## Workflow

1. **Gather profile context** — Understand who this person/org is and what they want to showcase
2. **Audit the current profile** — Score every element of the profile's public presence
3. **Generate the profile README** — Write a polished, scannable README.md
4. **Recommend metadata and configuration** — Advise on bio, pinned repos, settings, and widgets

---

## Phase 0: Gather Context

### Determine profile type

Ask the user (if not obvious): is this a **personal profile** or an **organization profile**? The mechanics differ significantly:

| Feature | Personal profile | Organization profile |
| --- | --- | --- |
| README location | `username/username/README.md` | `.github/profile/README.md` |
| Visibility options | Public only | Public + member-only (via `.github-private` repo) |
| Pinned repos | Up to 6 | Up to 6 public + 6 member-only |
| Contribution graph | Yes | No |
| Achievements | Yes | No |

### Collect information

You need to understand the person/org before writing anything. Gather:

- **Username** — needed for stats widget URLs and the magic repo name
- **Current role/company** — what they do now
- **Primary technologies** — languages, frameworks, tools they work with
- **What they want to showcase** — open source projects, work experience, learning journey, company products
- **Tone** — professional, casual, creative, minimal
- **Target audience** — recruiters, collaborators, potential investors, open source community

If `gh` is available (`gh auth status`), pull what you can automatically:

- `gh api user` — name, bio, company, location, blog, twitter
- `gh api users/{username}/repos?sort=stars&per_page=10` — top repos for pin recommendations
- Check if `username/username` repo exists: `gh repo view {username}/{username} --json name 2>/dev/null`

---

## Phase 1: Audit

If the user has an existing profile, audit it. If they're starting fresh, skip to Phase 2.

### Score Table

```text
Category                        Score
─────────────────────────────────────
Profile README                  x/10
Profile Metadata                x/10
Pinned Repositories             x/10
Contribution Activity           x/10
─────────────────────────────────────
Overall                         x/40
```

### What to evaluate

#### Profile README (x/10)

- **Does it exist?** If there's no `username/username` repo with a README.md, that's the biggest miss.
- **Structure** — Does it flow logically? The ideal order:
  1. Greeting and identity statement (name, role, one-sentence hook)
  2. What you're working on (current projects, 2-3 sentences)
  3. Tech stack (badges or icons via shields.io or devicon)
  4. GitHub stats (dynamically generated cards)
  5. Featured projects (beyond what's pinned)
  6. Contact and social links (badge-style links)
  7. Personal touch (fun fact, motto, learning goal)
- **Length** — Aim for 400-800 words. Under 200 feels thin. Over 2,000 feels cluttered and undermines credibility.
- **Scannability** — Can someone get the gist in 10 seconds? Use `<details>` tags for collapsible sections to keep the visible portion clean.
- **Freshness** — Is dynamic content (blog posts, activity) still updating? GitHub stops cron-based Action triggers after 60 days of repo inactivity.

#### Profile Metadata (x/10)

Every empty field is a missed opportunity. Check:

- **Profile photo** — Clear, professional headshot? Consistent with LinkedIn/Twitter?
- **Bio** — Filled in? (160 character limit.) States role, primary technology, one distinguishing trait?
- **Company** — Linked with `@` prefix to the employer's org?
- **Location** — Filled in?
- **Website** — Linked?
- **Social accounts** — Twitter/X, LinkedIn linked? Cross-linking between profiles builds trust.
- **Pronouns** — Using this field signals inclusivity.
- **Status** — Set to show current work, availability, or open-to-work?

#### Pinned Repositories (x/10)

You can pin up to 6 repos (including repos you've contributed to).

- **Are all 6 slots used?** Empty slots waste prime real estate.
- **Do pinned repos have descriptions?** A pinned repo with "No description provided" looks careless.
- **Is there variety?** Showcase different technologies and project types.
- **Social proof** — Do pinned repos have stars? Prioritize repos with more stars.
- **Alignment** — Do the pins match the kind of work or roles the person wants to attract?
- **README quality** — Each pinned repo should have a polished README (this is where the github-repo skill applies).

#### Contribution Activity (x/10)

- **Contribution graph** — Is it reasonably active? Gaps are fine, but a completely empty graph raises questions.
- **Private contributions** — Is "Include private contributions" enabled in settings? This shows activity from private repos without revealing details.
- **Achievement badges** — Notable badges like Starstruck, Pull Shark, Arctic Code Vault Contributor? These add credibility.

---

## Phase 2: Generate the Profile README

### For personal profiles

Create the `username/username` repo's `README.md`. The profile README should be:

- **Scannable** — someone should get the gist in 10 seconds

From courtneyr-dev/agent-skills, MIT.

More from courtneyr-dev/agent-skills