| name | gh-profile |
| description | Create and customize GitHub profile READMEs with stats cards, animations, badges, and GitHub Actions automation. |
| license | MIT |
This skill transforms GitHub profiles from basic to extraordinary. Your GitHub profile is your digital resume, portfolio, and personal brand—make it unforgettable.
What Users Want
Users typically want help with GitHub profile customization when they:
- Want to stand out to recruiters and collaborators
- Need to showcase their skills, projects, and achievements
- Want to add dynamic stats cards, streaks, and visualizations
- Are looking for automation with GitHub Actions
- Need inspiration from templates and examples
- Want to add animations, badges, or interactive elements
- Seek to integrate external services (blogs, LeetCode, Spotify, etc.)
What You Provide
You provide comprehensive GitHub profile customization guidance, including:
- Complete profile README creation from scratch
- Theme selection and customization (dracula, radical, tokyonight, synthwave, gruvbox, etc.)
- Stats cards and metrics (GitHub Stats, Streak Stats, Top Languages, Trophies, GitHub Trends)
- Animations (typing SVG, snake contribution graph, animated GIFs)
- Visitor counters and badges
- GitHub Actions automation for dynamic content
- External service integration (blog feeds, LeetCode, WakaTime, Spotify)
- GitHub Achievements system and earning strategies
- AI-powered profile generation assistance
- Advanced automation with Python scripts and GraphQL
- Best practices for performance, security, and accessibility
- Recruitment optimization strategies
- Troubleshooting and optimization
Understanding GitHub Profiles
What is a GitHub Profile?
A GitHub profile is a special README.md file that appears on your GitHub profile page at github.com/username. It's created through a unique repository named exactly like your username.
Why Create a Profile?
Your GitHub profile is your:
- Digital resume for recruiters and hiring managers
- Portfolio of your work and projects
- Personal brand showcase
- First impression for collaborators and employers
- Professional presence in the developer community
How It Works
- Create a repository named
YOUR_USERNAME (must match exactly)
- Add a
README.md file with markdown content
- The README automatically appears at
github.com/YOUR_USERNAME
- Anyone visiting your profile page sees your customized content
Important Notes
- The repository must be public for your profile to be visible
- The repository name must match your username exactly (case-sensitive)
- The
README.md file must be in the root directory
- You can have only one profile per GitHub account
2025 Trends & Best Practices
Current Design Trends
- Minimalist Professional: Clean, focused, strategic use of whitespace
- Themed Profiles: Tokyo Night, Dracula, Gruvbox, Synthwave (80s retro), One Dark
- Dynamic & Real-Time: Automated content via GitHub Actions
- Storytelling Profiles: Career timelines, journey mapping
- Performance-Optimized: Lightweight SVGs, efficient loading
- AI-Powered Generation: Smart template recommendations based on your activity
- Recruitment-Focused: Optimized layouts for ATS systems and recruiters
What Works in 2025
✅ Clean, branded profiles with consistent styling
✅ Strategic widget placement (stats, streak, languages)
✅ High contrast themes for accessibility
✅ Tech stack badges and social links
✅ Animated typing SVG and contribution snakes
✅ Visitor counters with geographic tracking
✅ Dynamic blog feeds via GitHub Actions
✅ Project showcases with repo cards
✅ GitHub Achievements displayed prominently
✅ Impact metrics ("Used by 10k+ users", "500+ stars")
❌ Overcrowded profiles with too many widgets
❌ Broken or slow-loading images
❌ Generic templates without customization
❌ Low contrast color schemes
❌ Excessive GIFs that hurt performance
❌ Missing or outdated contact information
How to Help Users
Initial Assessment
When a user requests help, first understand their needs:
- Profile Status: Do they have a profile README already? What's their GitHub username?
- Goals: Job hunting? Personal branding? Showcasing projects? Community building?
- Style Preference: Minimalist, creative, themed, professional, animated?
- Technical Comfort: Beginner needing generators, or advanced wanting custom automation?
- Key Features: Stats cards? Visitor counter? Blog automation? Animations?
Quick Diagnostic Questions
If they have no profile yet:
- Do you have a GitHub account? What's your username?
- Have you created a repository with your username?
- Are you comfortable with markdown, or would you prefer a generator tool?
If they have an existing profile:
- Share your profile URL so I can see what you have
- What do you like about your current profile?
- What do you want to improve or add?
For customization goals:
- Are you job hunting? (Recruiters love clean, professional profiles)
- Do you want to showcase specific projects or skills?
- Are you looking to build a personal brand?
- Do you write blog posts you want to feature?
Step-by-Step Guidance
For Complete Beginners (No Profile Yet)
Quick Start: Your First Profile in 5 Minutes
Step 1: Create Your Profile Repository
- Go to GitHub and click the "+" icon → "New repository"
- CRITICAL: Name the repository exactly your username (e.g.,
johndoe)
- Set it to Public (private profiles won't work)
- Check "Initialize with README"
- Click "Create repository"
Step 2: Add Your Profile Content
Copy this entire block and paste it into your README.md (replace the placeholders):
<div align="center">
# Hi, I'm Your Name! 👋
I'm a developer who loves building things that live on the internet.
## 🚀 What I'm Working On
- Currently building [your current project]
- Learning [technology you're learning]
- Open to collaborations on [topics you're interested in]
## 💬 Let's Connect
- Email: your.email@example.com
- LinkedIn: linkedin.com/in/yourprofile
- Twitter: @yourhandle
---
*This profile is a work in progress!*
</div>
Step 3: Verify It Works
- Commit your changes (click "Commit changes")
- Visit
github.com/YOUR_USERNAME (not the repository, your main profile)
- Wait 10-30 seconds and refresh
- You should see your new profile!
That's it! You now have a working GitHub profile. Ready to level up? Continue below.
✅ Profile Setup Checklist
Before customizing further, verify:
Not seeing your profile? See Troubleshooting
For Beginners Wanting Enhancement
Once you have a basic profile, add these features one at a time:
1. Add GitHub Stats Card
- Shows your stars, forks, contributions
- Choose a theme (dracula, radical, tokyonight)
2. Add Tech Stack Badges
- Display your programming languages
- Add frameworks and tools you use
3. Add Social Links
- Email, LinkedIn, Twitter, Website
- Use badge formats for consistency
4. Add Visitor Counter
- Track how many people visit your profile
- Geographic data if desired
5. Add Featured Projects
- Link to your best repositories
- Include brief descriptions
For Intermediate Users (Existing Profile, Want Enhancement)
1. Add Stats Cards (github-readme-stats)
2. Add Streak Stats
3. Add Profile Trophy
4. Add Visitor Counter
5. Add Tech Stack Icons
6. Add Typing Animation
7. Integrate Blog Feed (GitHub Actions)
8. Add Snake Contribution Animation
For Advanced Users (Want Automation & Customization)
1. Set Up GitHub Actions Workflows
- Automated blog post updates
- Dynamic content generation
- Custom SVG generation
- External API integrations
2. Create Custom Scripts
- Python/Node.js for data fetching
- Jinja2 templates for content
- GraphQL queries for complex data
3. Optimize Performance
- Caching strategies
- API rate limiting
- Lazy loading for large content
- SVG optimization
4. Implement Security Best Practices
- Token management
- Permission limiting
- Secret management
Component Reference Guide
All code snippets below go in your README.md unless otherwise specified.
Stats Cards
GitHub Readme Stats (Most Popular)
Parameters Explained:
username=YOUR_USERNAME - Your GitHub username (required)show_icons=true - Show service icons next to labelstheme=dracula - Color scheme (dracula, radical, tokyonight, gruvbox, synthwave, etc.)hide_border=true - Remove card bordertitle_color=00ff00 - Custom title color (hex code)bg_color=000000 - Custom background color (hex code)
Available Themes:
dark, light, dracula, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, monokai, nord, gotham
Top Languages Card
Repository Pin Card
GitHub Trends (Advanced Metrics)
[](https://github.com/avgupta456/github-trends)
Features:
- Lines of Code (LOC) statistics
- Advanced metrics beyond basic stats
- Customizable visualizations
Streak Stats
[](https://git.io/streak-stats)
Parameters:
theme=dracula - Color themehide_border=true - Remove bordermode=daily - Show daily contributionsstroke=00ff00 - Custom stroke color
Profile Trophy
[](https://github.com/ryo-ma/github-profile-trophy)
Parameters:
no-frame=true - Remove trophy frameno-bg=true - Remove backgroundcolumn=4 - Number of columns (default: 7)margin-w=4 - Width margin
Animations
Typing SVG
File: README.md
[](https://git.io/typing-svg)
Parameters:
font=Fira+Code - Font family (Fira+Code, monospace, Arial, etc.)size=32 - Font size in pixelsduration=2800 - Typing duration in millisecondspause=2000 - Pause between typing cyclescolor=00ff00 - Text colorcenter=true - Center alignmentlines=Line1;Line2;Line3 - Lines to type (semicolon-separated)
Snake Animation (GitHub Actions)
File: .github/workflows/snake.yml
name: Generate Snake
on:
schedule:
- cron: "0 0 * * *"
workflow_dispatch:
jobs:
generate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: Platane/snk@v3
with:
github_user_name: ${{ github.repository_owner }}
outputs: |
dist/github-snake.svg
dist/github-snake-dark.svg?palette=github-dark
dist/ocean.gif?generator_ocean
- uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./dist
Usage in README.md:
GitHub Achievements
Understanding Achievements
GitHub Achievements are badges you earn for various activities on the platform. They add gamification to your profile and demonstrate your engagement with the GitHub community.
Achievement Levels
- DEFAULT - Basic achievements everyone earns
- BRONZE - Intermediate achievements for consistent activity
- SILVER - Advanced achievements for dedicated contributors
- GOLD - Expert achievements for exceptional accomplishments
Common Achievements & How to Earn Them
Starstruck (DEFAULT/Bronze)
- Created a repository that earned many stars
- How to earn: Create useful, high-quality repositories that people want to use
Arctic Code Vault (Bronze/Silver)
- Contributed to the Arctic Code Vault archive
- How to earn: Have contributions between Feb 2020 - Apr 2020
Pull Shark (Bronze/Silver/Gold)
- Made many pull requests
- How to earn: Contribute PRs regularly (Bronze: 10+, Silver: 100+, Gold: 500+)
YOLO (Bronze)
- Created a public repository and renamed default branch
- How to earn: Rename
master branch to main or any other name
Quickdraw (Bronze)
- Quick response to issues
- How to earn: Comment on issues quickly after they're opened
Pair Extraordinaire (Bronze/Silver)
- Co-authored commits with others
- How to earn: Use
@ mentions in commit messages
Galaxy Brain (Bronze/Silver)
- Answers marked as helpful in discussions
- How to earn: Provide helpful answers in GitHub Discussions
Mind Blowing (Bronze)
- Received 10+ reactions on a discussion answer
- How to earn: Give exceptionally helpful answers
How to Display Achievements
Achievements automatically appear on your profile once earned. To maximize them:
-
Focus on quality contributions
- Create repos that solve real problems
- Write clear documentation
- Provide helpful examples
-
Consistent activity
- Make regular contributions
- Engage with issues and PRs
- Participate in discussions
-
Community engagement
- Collaborate with others
- Co-author commits
- Review pull requests
-
Create popular repositories
- Build tools developers need
- Write clear READMEs
- Respond to issues promptly
Achievement Resources
Visitor Counters
Basic Visitor Counter
Profile Views Counter
Visitor Badge with Country Flags
Tech Stack Icons
Skill Icons (Interactive)
[](https://skillicons.dev)
Badge Format (Static)
Tech Stack Generator Icons
<div align="center">
<img src="https://techstack-generator.vercel.app/react-icon.svg" alt="React" width="50" height="50" />
<img src="https://techstack-generator.vercel.app/js-icon.svg" alt="JavaScript" width="50" height="50" />
<img src="https://techstack-generator.vercel.app/python-icon.svg" alt="Python" width="50" height="50" />
<img src="https://techstack-generator.vercel.app/ts-icon.svg" alt="TypeScript" width="50" height="50" />
<img src="https://techstack-generator.vercel.app/docker-icon.svg" alt="Docker" width="50" height="50" />
AI-Powered Profile Generation
AI-Assisted Generators (2025 Trend)
AI-powered tools can help you create your profile faster:
Top AI-Powered Generators
-
ReadMeCodeGen
-
rahuldkjain/github-profile-readme-generator
-
Using ChatGPT/Claude
- Generate profile content with AI assistance
- Example prompt: "Create a GitHub profile README for a senior React developer who loves open source, contributes to React libraries, and is interested in GraphQL and TypeScript."
How to Use AI Effectively
- Describe your skills and experience to the AI
- Let AI suggest appropriate widgets and layouts
- Customize the generated output to maintain authenticity
- Add your unique voice and personality
Example AI Prompts
For Job Seekers:
"Create a GitHub profile README for a senior full-stack developer with 5 years experience. Skills: React, Node.js, Python, AWS. Looking for senior roles. Include stats cards, tech stack badges, and featured projects with impact metrics."
For Open Source Contributors:
"Create a minimalist GitHub profile for an open source enthusiast. Focus on contributions, starred repos, and community engagement. Use Tokyo Night theme. Include activity graph and contribution snake."
For Students/Juniors:
"Create a GitHub profile for a computer science student passionate about web development. Include learning journey, current projects, and contact information. Keep it clean and professional."
External Service Integration
Blog Feeds
File: .github/workflows/blog-posts.yml
name: Blog Posts
on:
schedule:
- cron: '0 */6 * * *'
workflow_dispatch:
jobs:
update-blog:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: gautamkrishnar/blog-post-workflow@v1
with:
comment_tag_name: BLOG_POST_LIST
feed_list: "https://yourblog.com/feed.xml,https://medium.com/feed/@yourusername"
max_post_count: 5
feed_item_custom_template: "- [$title]($url)"
date_format: "MMM DD, YYYY"
In README.md:
## 📝 Latest Blog Posts
<!-- BLOG_POST_LIST:START -->
<!-- BLOG_POST_LIST:END -->
Coding Stats
WakaTime Integration
File: .github/workflows/wakatime.yml
name: WakaTime Stats
on:
schedule:
- cron: '0 0 * * *'
workflow_dispatch:
jobs:
update-wakatime:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: lowlighter/metrics@latest
with:
filename: metrics.svg
token: ${{ secrets.METRICS_TOKEN }}
base: header, activity, community, repositories, metadata
plugin_wakatime: yes
plugin_wakatime_sections: time, languages, languages-graphs, projects, history
plugin_wakatime_token: ${{ secrets.WAKATIME_API_KEY }}
Setup:
- Sign up at https://wakatime.com/
- Get your API key from settings
- Add
WAKATIME_API_KEY to GitHub repository secrets
- Add metrics SVG to README
LeetCode Stats
Parameters:
theme=Dark - Color theme (Dark, Light, Radical)mode=card - Display mode (default, card)
Spotify Now Playing
File: .github/workflows/spotify.yml
name: Update Spotify
on:
schedule:
- cron: '*/15 * * * *'
workflow_dispatch:
jobs:
spotify:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses:athul/waka-readme@master
with:
WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
Performance & Security
Performance Best Practices
Optimize Loading Speed
-
Limit External Images
- Use SVG instead of PNG/JPG when possible
- Combine multiple stats into single cards
- Remove unused widgets regularly
-
Lazy Loading
<details>
<summary>Click to expand more stats</summary>
<br>
</details>
- Caching Strategies
File: .github/workflows/cached-update.yml
name: Cached Profile Update
on:
schedule:
- cron: '0 0 * * *'
workflow_dispatch:
jobs:
update:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Cache node modules
uses: actions/cache@v4
with:
path: ~/.npm
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.os }}-node-
- name: Your update script
run: |
# Your update commands here
- name: Check for changes
id: check-changes
run: |
if git diff --quiet HEAD README.md; then
echo "has_changes=false" >> $GITHUB_OUTPUT
else
echo "has_changes=true" >> $GITHUB_OUTPUT
fi
API Rate Limiting
When fetching data from APIs:
- Use authentication for higher rate limits
- Implement caching to reduce API calls
- Batch requests when possible
- Use GraphQL instead of multiple REST calls
Security Best Practices
1. Never Expose Secrets
BAD:
run: echo "API_KEY=12345" > config.txt
GOOD:
run: echo "API_KEY=${{ secrets.API_KEY }}" > config.txt
2. Use GitHub Secrets
Add secrets in: Repository Settings → Secrets and variables → Actions
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
API_KEY: ${{ secrets.API_KEY }}
SPOTIFY_CLIENT_ID: ${{ secrets.SPOTIFY_CLIENT_ID }}
3. Limit Workflow Permissions
permissions:
contents: write
pull-requests: read
4. Use Pinned Versions
- uses: actions/checkout@master
- uses: actions/checkout@v4
- uses: actions/checkout@8ade135a41bc03ea155e62e844d2df94e0d05d4b
5. Token Rotation
- Use personal access tokens with minimal permissions
- Set expiration dates on tokens
- Review token access regularly
- Rotate tokens periodically
Accessibility
WCAG Compliance
-
High Contrast
- Use themes like
highcontrast, dracula, tokyonight
- Avoid low contrast custom colors
- Test contrast ratio (minimum 4.5:1 for normal text)
-
Alt Text
- Provide alt text for all images
- Example:
-
Screen Reader Friendly
- Use semantic HTML (
<div align="center">, <details>, etc.)
- Ensure proper heading hierarchy
- Test with screen readers
-
Color Blind Safe
- Don't rely on color alone to convey information
- Use symbols/icons along with colors
- Test with color blindness simulators
-
Keyboard Navigable
- Ensure all links are accessible via keyboard
- Test tab order
- Include focus indicators
Recommended Themes for Accessibility
- High Contrast - Maximum accessibility (WCAG AAA)
- Dracula - Good contrast, very popular
- Tokyo Night - Easy on eyes, excellent readability
- One Dark - Professional, high contrast
Avoid: Custom themes with low contrast ratios
Templates
Minimalist Professional Template
<div align="center">
# Hi, I'm Your Name 👋
[](https://yourwebsite.com)
[](https://twitter.com/yourusername)
[](https://linkedin.com/in/yourusername)
</div>
## About Me
I'm a [Your Role] passionate about [Your Interests].
- 🔭 Currently working on [Project]
- 🌱 Learning [Technology]
- 👯 Open to collaborations on [Topic]
- 💬 Ask me about [Expertise]
## Tech Stack
[](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
[](https://www.python.org/)
[](https://reactjs.org/)
## GitHub Stats
<div align="center">
<img width="49%" src="https://github-readme-stats.vercel.app/api?username=YOUR_USERNAME&show_icons=true&theme=dracula&hide_border=true" />
[]() - Description
[]() - Description
[]() - Description
[]()]()
Recruitment-Optimized Template
<div align="center">
# Senior Full Stack Developer | React, Node.js, AWS | Open Source Contributor
[](https://linkedin.com/in/yourprofile)
[](mailto:your@email.com)
</div>
## About Me
Experienced full-stack developer with 5+ years building scalable web applications. Passionate about clean code, performance optimization, and mentoring junior developers.
## Tech Stack
### Frontend
[](https://reactjs.org/)
[](https://www.typescriptlang.org/)
[](https://nextjs.org/)
### Backend
[](https://nodejs.org/)
[](https://www.python.org/)
[](https://www.postgresql.org/)
### Cloud & DevOps
[](https://aws.amazon.com/)
[]()
[]()]()
React, Node.js, PostgreSQL, AWS, Docker
Launched product serving 10,000+ active users
Achieved 99.9% uptime with auto-scaling
Featured on ProductHunt, 500+ GitHub stars
Link: []()
TypeScript, WebSocket, Redis, Grafana
Reduced data processing time by 60%
Handles 1M+ events per day
Real-time visualization for 500+ concurrent users
Link: []()
Active contributor to [popular repo 1]
Maintainer of [popular repo 2] with 1k+ stars
500+ contributions across 50+ repositories
your.email@example.com
linkedin.com/in/yourprofile
github.com/YOUR
Storytelling Timeline Template
<div align="center">
# 👋 Hi, I'm Your Name
</div>
## 📖 My Journey
### 🌱 2020 - Where It Started
- Built my first website with HTML & CSS
- Fell in love with coding and problem-solving
- Started learning JavaScript and Python
### 🚀 2021 - Growth
- First open source contribution to [project]
- Landed my first developer job at [company]
- Learned React, Node.js, and PostgreSQL
- Built [first significant project]
### 💡 2022 - Expertise
- Promoted to Senior Developer
- Started technical blog (10k+ views)
- Mentored 5 junior developers
- Contributed to [major open source project]
### 🔥 2023 - Present
- Full-stack architect at [company]
- 1000+ GitHub contributions
- Maintainer of [project] (500+ stars)
- Building products that matter
---
## 🏆 Achievements
<div align="center">
<img src="https://github-profile-trophy.vercel.app/?username=YOUR_USERNAME&theme=dracula&no-frame=true&no-bg=true&margin-w=4" />
</div>
---
[]()]()
---
[]()]()
[]()]()
[]()]()
Common Issues & Solutions
Profile Not Showing
Problem: Your profile isn't visible on your GitHub page
Solutions:
- Repository name must exactly match your username (case-sensitive)
- Repository must be public (not private)
- README.md must be in the root directory
- Wait 1-2 minutes for GitHub to rebuild your profile
- Try hard refresh: Ctrl+Shift+R (Windows/Linux) or Cmd+Shift+R (Mac)
Stats Not Updating
Problem: Stats cards showing old data
Solutions:
- Stats update daily (not real-time)
- Check your username spelling in URLs
- Wait 24 hours for changes to propagate
- Clear browser cache
Images Not Loading
Problem: Widget or badge images not displaying
Solutions:
- Use HTTPS for all image URLs
- Verify image URLs are correct
- Check if the service is temporarily down
- Try alternative badge/counter services
GitHub Actions Failing
Problem: Workflows not running or failing
Solutions:
- Check workflow file syntax (YAML indentation matters!)
- Verify secrets are properly configured
- Check Actions tab for error logs
- Ensure repository has Actions enabled
Layout Issues on Mobile
Problem: Profile looks bad on mobile devices
Solutions:
- Limit widget width to 100%
- Avoid too many side-by-side elements
- Use
<div align="center"> for centering
- Test on multiple devices
Too Many Widgets
Problem: Profile is cluttered and slow
Solutions:
- Remove unused or redundant widgets
- Combine multiple stats into single cards
- Use
<details> for expandable content
- Focus on essential information only
Generator Tools
Quick-Start Generators
For users who want a profile in under 5 minutes:
-
rahuldkjain/github-profile-readme-generator ⭐ Most Popular
-
ProfileMe.dev
-
Readmefy
- Web: https://readmefy.life/
- Professional templates
- Tech stack badges included
- Stats cards integration
- Clean interface
-
ReadMeCodeGen
-
Coderspace GitHub ReadMe Generator
-
awesomegithub.web.app
Inspiration & Resources
Curated Collections
Popular Examples (2025)
- Neofetch-style terminal profiles - Command-line aesthetic
- Rainbow workflow designs - Colorful contribution graphs
- Minimalist professional - Clean, focused layouts
- Animated SVG profiles - Interactive animations
- Storytelling timelines - Career journey visualizations
Learning Resources
Advanced Automation
GitHub Actions Cron Reference
Cron Format
┌───────────── minute (0 - 59)
│ ┌───────────── hour (0 - 23)
│ │ ┌───────────── day of month (1 - 31)
│ │ │ ┌───────────── month (1 - 12)
│ │ │ │ ┌───────────── day of week (0 - 6)
│ │ │ │ │
* * * * *
Common Schedules
- cron: '0 * * * *'
- cron: '0 0 * * *'
- cron: '0 */6 * * *'
- cron: '0 9 * * 1'
- cron: '0 8,18 * * *'
- cron: '0 9 * * 1-5'
- cron: '0 0 1 * *'
Python Script Automation
File: scripts/update_readme.py
import requests
import re
def fetch_latest_repos(username):
"""Fetch user's latest repositories"""
url = f"https://api.github.com/users/{username}/repos"
response = requests.get(url)
return response.json()[:6]
def update_readme(readme_path, marker, content):
"""Update a section in README between markers"""
with open(readme_path, 'r') as f:
readme = f.read()
start_marker = f'<!-- {marker}_START -->'
end_marker = f'<!-- {marker}_END -->'
pattern = f'{start_marker}.*?{end_marker}'
replacement = f'{start_marker}\n{content}\n{end_marker}'
readme = re.sub(pattern, replacement, readme, flags=re.DOTALL)
with open(readme_path, 'w') as f:
f.write(readme)
if __name__ == '__main__':
username = "YOUR_USERNAME"
repos = fetch_latest_repos(username)
content = "### Latest Repos\n\n"
for repo in repos:
content += f"- [{repo['name']}]({repo['html_url']}) - {repo.get('description', 'No description')}\n"
update_readme(, , content)
In workflow:
- name: Update README with Python
run: |
python scripts/update_readme.py
Your Approach
When helping users create their GitHub profile:
- Assess First: Understand their goals, experience level, and preferences
- Start Simple: Begin with a basic structure, then add features
- Provide Options: Offer multiple approaches (generators vs manual, minimalist vs creative)
- Educate: Explain what each component does and why it's valuable
- Iterate: Build in stages, get feedback, refine
- Test: Remind users to check on mobile and different themes
- Maintain: Emphasize keeping content updated
Remember: A great GitHub profile balances personality, professionalism, and purpose. It should authentically represent the user while being fast, accessible, and maintainable.
Quick Start Commands
# Basic Profile (5 minutes)
1. Create username/username repository (public)
2. Add README.md with intro, skills, contact
3. Add stats card: 
4. Verify at github.com/YOUR_USERNAME
# Enhanced Profile (15 minutes)
5. Add streak stats: 
6. Add trophy: 
7. Add visitor counter: 
8. Add typing animation and tech stack badges
# Advanced Profile (1 hour)
9. Set up GitHub Actions for blog feed
10. Add snake contribution animation
11. Create custom workflow for dynamic content
12. Optimize performance and accessibility
13. Implement security best practices
The goal is to help users create profiles that are memorable, professional, and uniquely theirs—profiles that make recruiters take notice and collaborators want to connect.
