Issue with Profile README.md

[Waqas649]

🏷️ Discussion Type

Bug

💬 Feature/Topic Area

Profile

Body

GitHub Profile README Not Showing
I created a public repository to display my profile README, but it's not appearing on my GitHub profile.
What I've tried:

• Created repo with my current username: Waqas649
• Also tried with my old username: Aerionix649
• Added README.md file to the repository

Repo is also public

The README still doesn't show on my profile page. Has anyone else experienced this? What am I missing?

[github-actions[bot]]

💬 Your Product Feedback Has Been Submitted 🎉

Thank you for taking the time to share your insights with us! Your feedback is invaluable as we build a better GitHub experience for all our users.

Here's what you can expect moving forward ⏩

• Your input will be carefully reviewed and cataloged by members of our product teams. 
  • Due to the high volume of submissions, we may not always be able to provide individual responses.
  • Rest assured, your feedback will help chart our course for product improvements.
• Other users may engage with your post, sharing their own perspectives or experiences. 
• GitHub staff may reach out for further clarification or insight. 
  • We may 'Answer' your discussion if there is a current solution, workaround, or roadmap/changelog post related to the feedback.

Where to look to see what's shipping 👀

• Read the Changelog for real-time updates on the latest GitHub features, enhancements, and calls for feedback.
• Explore our Product Roadmap, which details upcoming major releases and initiatives.

What you can do in the meantime 💻

• Upvote and comment on other user feedback Discussions that resonate with you.
• Add more information at any point! Useful details include: use cases, relevant labels, desired outcomes, and any accompanying screenshots.

As a member of the GitHub community, your participation is essential. While we can't promise that every suggestion will be implemented, we want to emphasize that your feedback is instrumental in guiding our decisions and priorities.

Thank you once again for your contribution to making GitHub even better! We're grateful for your ongoing support and collaboration in shaping the future of our platform. ⭐

[queenofcorgis]

Hey there! 👋

Thanks for posting in the GitHub Community, @Waqas649 ! We're happy you're here. You are more likely to get a useful response if you are posting in the applicable category. The Accessibility category is a place for our community to discuss and provide feedback on the digital accessibility of GitHub products. Digital accessibility means that GitHub tools, and technologies, are designed and developed so that people with disabilities can use them.

I've gone ahead and moved this to the correct category for you, Other Feature Feedback, Questions, and Ideas. Good luck!

[arpalanca]

Hi, I just added mine just recently and here are the checklists I've followed:

• Make sure the repository name exactly matches your GitHub username.
• The repo is public.
• The default branch should be main. Ensure your README.md is on the default branch.
• The README.md file should be in the root of the repository.
• Make sure the filename is correct (README.md) and that it contains valid Markdown.
• Ensure your special repository is not pinned or hidden.
• Make sure there are no syntax errors in your README.md that might prevent rendering.

Sometimes, it takes a few moments for GitHub to update the profile page after changes. Try refreshing with cache clearing or view your profile in an incognito window. Hope this helps.

[sefin23]

Here are the most common reasons a Profile README might not show up or have issues:

Wrong repository name — The repo must be named exactly the same as your GitHub username (case-sensitive). For example, if your username is johnsmith, the repo must be named johnsmith.

Repo must be Public — A private repo won't display on your profile. Go to Settings → Change visibility → Make public.

File must be named README.md — Make sure it's in the root of the repository (not inside a subfolder).

Clear cache — Sometimes GitHub takes a few minutes to reflect changes. Try a hard refresh (Ctrl+Shift+R) or check in a different browser/incognito.

Check the repo is initialized — Make sure the README.md actually has content committed and pushed.
If you share what specific issue you're seeing (not showing at all, formatting broken, etc.), happy to help narrow it down!

[Ayouub-aj]

To display a profile README on your GitHub profile, you need to ensure the following steps are properly followed:

Repository Name: The repository must be named exactly the same as your current GitHub username (case-sensitive). In your case, since your current username is Waqas649, the repository should also be named Waqas649.

Public Repository: Ensure that the repository is public. Based on your description, it seems you’ve already done this.

README.md File: The repository must include a README.md file in the root directory. Double-check that the file is named exactly README.md (case-sensitive) and not something like readme.md or README.MD.

No Branch Issues: Make sure the default branch of the repository (usually main or master) contains the README.md file. If you have multiple branches, ensure that the README.md is in the default branch.

No Draft PRs: If you’ve recently edited the README.md file, ensure that the changes are committed and merged into the default branch and not sitting in a draft pull request.

Check GitHub Profile Settings: Go to your GitHub profile and ensure there are no settings that might disable the display of the profile README.

If you’ve confirmed all of the above and the README still doesn’t show:

Double-check that your username is correct and hasn't changed recently.
Clear your browser cache or try accessing your profile in an incognito/private browsing mode to rule out caching issues.
Wait for a few minutes as sometimes GitHub might take a little time to update changes.
If none of these steps resolves the issue, you may want to contact GitHub support for further assistance.

If this was useful, I would appreciate it if you could mark it as an answer. best regard!

[Waqas649]

Issue solved. Thanks man

[Ayouub-aj]

Please mark this response as the answer if it resolves your query.