GitHub Profile README Template
GitHub profile page: intro, current focus, tech stack, featured projects table, writing and talks, contact
Cara menggunakan: Use for the README of the repository named after your GitHub username. Write the one-paragraph intro and featured projects first. The main pitfall is length and clutter: keep it to one screen and avoid slow third-party widgets.
Pratinjau
Hi, I'm [Your name]
GitHub profile README template. GitHub shows this file at the top of your profile when it is the README.md of a public repository whose name matches your username exactly (for example
octocat/octocat). Replace every[bracketed]value and every line marked Example.
[Role, for example "Backend engineer"] at [Company or "independent"], based in [City / time zone]. I build [what you build, for example "fast, boring, reliable APIs for logistics companies"] and care about [two interests, for example "developer experience and observability"].
Currently
- Working on [project or problem, for example "a Rust rewrite of our route-planning service"]
- Learning [topic, for example "distributed tracing with OpenTelemetry"]
- Open to [opportunities, for example "open-source maintainers looking for reviewers"]
- Example: Speaking at [Conference] in [Month YYYY] about [topic]
Tech stack
| Area | Tools I use daily |
|---|---|
| Languages | [Go, TypeScript, SQL] |
| Backend | [PostgreSQL, Redis, gRPC] |
| Frontend | [React, Next.js] |
| Infrastructure | [Kubernetes, Terraform, GitHub Actions] |
| Currently exploring | [Rust, WebAssembly] |
Featured projects
| Project | What it does | Stack | Status |
|---|---|---|---|
| project-one | Example: CLI that diffs two OpenAPI files and flags breaking changes | Go | Active, 1.2k stars |
| project-two | Example: Self-hosted uptime monitor with SMS alerts | TypeScript | Maintained |
| project-three | [One-line description] | [Stack] | [Status] |
Pin the same repositories on your profile so the README and the pinned cards agree.
Writing and talks
- Article title: [one-line summary], YYYY
- Talk title at [Event], YYYY (slides)
- Example: Why we moved off cron: replacing 40 cron jobs with a queue, 2026
How to reach me
- Website: [https://example.com]
- Email: [[email protected]]
- [Mastodon / LinkedIn / Bluesky]: [handle or URL]
- Best for: [code review requests, speaking invitations, consulting questions]
I usually reply within [two working days]. For bugs in my projects, please open an issue in the repository instead of emailing.
Keeping it short
A profile README is a landing page, not a CV. Aim for one screen on a laptop. Choose three to six featured projects and update them when your focus changes. Prefer text and links over images, because text is searchable, accessible to screen readers and quick to load. If you add images, give every one meaningful alt text. Review the page every few months; an out-of-date "Currently" section is the most common sign of an abandoned profile.
Standard and licence note
Based on GitHub's profile README feature (a README.md in a public repository named after the account) and common practice for developer profiles. Original text written for this collection. Template licence: MIT.
Templat terkait
Library and Package README Template
README for a published library: badges, install per package manager, quick start, API table, config, compatibility, SemVer
Perangkat Lunak & RekayasaDetailed README Template
Heavyweight README (Best-README structure) – TOC, shields refs
Perangkat Lunak & RekayasaREADME Template
Lean project README – badges, config table, mermaid