# GitHub profile and repository structure

## Profile rules

- keep the username aligned with other public surfaces when possible
- treat the 160-character bio as a compact role summary: `Role | Stack | Location or Remote`
- put the portfolio or main public site in the dedicated Website field instead of spending bio space on a URL
- pin four to six finished, documented repositories
- prefer public contributions and visible maintenance as credibility signals
- use the contribution settings in a way that matches the user's actual public goals

## Repository metadata rules

- use descriptive, hyphenated repository names
- avoid opaque codenames when discoverability matters
- fill the repository About field with a short, concrete description
- use relevant topic tags up to the useful limit; include stack, architecture, and use-case tags where accurate
- add a custom social preview image for showcase repositories when possible

## README rules

- give every serious repository a real README
- put a quickstart or installation path near the top
- explain what the project is, why it exists, and how to evaluate it
- for showcase repositories, include architecture, constraints, and proof of maintenance
- for profile READMEs, keep the first paragraph compact and keyword-rich

## Trust signals

- releases, CI badges, LICENSE, SECURITY.md, and CODEOWNERS support human evaluation
- treat stars and forks as social proof, not as deterministic ranking levers
- good issue and PR hygiene helps repositories look maintained

## Anti-patterns

- undocumented pinned repos
- single giant `initial commit`
- vague About text
- showcasing dead or trivial repos instead of strongest work
