Optimize GitHub profiles and READMEs for developer discovery

GitHub Presence guides project presentation where developers evaluate a repository before trying it. It starts by reading available developer-audience context and auditing the profile, pinned repositories, and READMEs. The work connects first-impression clarity with discovery, community activity, and measurement.

The README structure includes a one-line explanation, features, quick start, installation methods, usage examples, full documentation, and licensing. Recommended supporting elements include a logo or banner, meaningful badges, an immediate hero example, and contribution guidance. Examples distinguish basic from advanced usage and organize documentation destinations so a reader can move from evaluation to implementation.

Badge guidance separates CI status, package version, licensing, adoption, coverage, security, and community signals. Downloads or coverage belong where they are meaningful, and excessive badges create clutter. Badge options include Shields.io, Badgen, and native GitHub badges. Images should work, include alternative text, and support readable layouts rather than obscure the project's purpose.

Profile setup uses a username-matching repository and README.md. The profile should remain scannable, highlight selected projects and current activity, include contact methods, and retain personality. Pinned repositories support the same focused presentation instead of listing everything.

Use this skill when optimizing a GitHub README, profile, project discoverability, or developer-facing presentation. It fits a repository audit as well as a broader plan for topics, relevant awesome lists, and GitHub-based marketing.

Avoid walls of text, stale profiles, broken images, unnecessary badge clutter, unanswered issues, and missing licenses or contribution guidelines. External examples, dependencies, commands, credentials, and service behavior require verification against the local project before changes are applied. Destructive or costly actions still require the appropriate user approval.

Inputs include audience context, current repository metadata, documentation, installation and usage details, selected projects, community channels, and traffic data. Outputs include a README structure, profile improvements, badge selection, discovery actions, automation examples, and an audit checklist.

Use up to 20 topics, keep the repository description within 350 characters, and aim for a quick start under two minutes. Coverage badges are recommended above 70%. Discovery topics can represent technology, framework, use case, category, and problem. Search discovery considers repository name, description, indexed README text, topics, and detected language. Awesome-list submissions require finding relevant lists, checking quality and activity criteria, meeting the list's requirements, and following its contribution process.

GitHub Actions examples update blog-post lists, generate profile metrics, and announce releases. Sponsorship guidance covers joining GitHub Sponsors, describing tiers, and configuring repository funding. Repository funding can be configured as follows:

github: [yourusername]
patreon: yourpatreon
open_collective: yourproject
ko_fi: yourkofi
custom: ["https://buymeacoffee.com/you"]

Success measurement distinguishes stars, forks, clones, views, referrers, and contributors. Repository Traffic insights provide visitor counts, popular files, referring sites, and clone activity. The audit also checks keyword clarity, copy-pasteable examples, working HTTPS links, mobile readability, topics, and a social preview image.

Named tools include Octolens for relevant mentions and discussions, Shields.io for badges, GitHub Readme Stats and Metrics for profile statistics, Carbon for code screenshots, and readme.so for README creation. Related skills cover developer-audience context, Hacker News, Reddit, and developer publishing channels.