How to Update the Description of Your Repository on GitHub

[jihanurrahman33]

Select Topic Area

Show & Tell

Body

How to Update the Description of Your Repository on GitHub

Hi everyone 👋,

I’ve seen some users asking how they can update the description of their GitHub repositories. Since this can be confusing for new users, here’s a step-by-step guide:

---

Method 1: From the Repository Homepage

1. Open your repository on GitHub.
2. At the top of the page (just under the repo name), you’ll see a Description box.
   • If no description exists yet, it may say “Add a description”.
3. On the right side of that box, click the small pencil icon (✏️).
4. Edit the following fields:
   • Description → a short summary of what your project does.
   • Website (optional) → a URL to your documentation, demo, or related site.
5. Press Save (or hit Enter).

---

Method 2: From Repository Settings

1. Open your repository and click on the Settings tab.
2. Under General, scroll down to the Repository details section.
3. You’ll find fields for Description and Website.
4. Update them as needed.
5. Scroll down and click Save changes (if required).

---

⚠️ Important: You need admin or maintainer access to the repository to make these changes. If you don’t see the pencil icon or the settings option, it means you don’t have the right permissions.

---

✅ Once updated, the new description will appear:

• At the top of your repository page.
• In GitHub search results.
• On your profile if the repo is pinned.

Hope this helps both newcomers and anyone who wants to keep their projects well-described! 🚀

[sirajahmedx]

@jihanurrahman33 Thanks for sharing this guide!

[pcimring-taboola]

I can access the Settings tab of my repo - but I do not see a section called Repository details.

Neither does the description appear at the top of my repository page (although I do see it in other contexts - e.g. when providing another platform with access to the repo).

What am I missing?

[fjordaan]

The instructions above are incorrect. It is the cog icon next to the About box on the repo homepage.

[pcimring-taboola]

This worked for me - thanks

[mapostore]

ok, it works only if there is code inside repo

[farazkhan2000]

To update the description of your GitHub repository:

1. Go to your repository on GitHub.
2. At the top, just below the repository name, you’ll see a short text box labeled “Add a description…” or your existing description.
3. Click on it and type your new description.
4. Press Enter or click outside the box to save it.

Optionally, you can also add a website URL in the box next to it if relevant.

This updates the repository description that appears on your profile and in search results.

[maomenfl]

Can anyone provide a screenshot instead of just guessing

[ptu-gh]

All the instructions shared here are wrong as of July 2026. Ridiculous that GitHub makes it so hard to find such a basic feature.

[pcimring-taboola]

The instruction provided above by @fjordaan (above) still works for me.

[air3ijai]

In case when repository does not contain code - Cannot edit repository description when no code has been provided #43623

And a solution with GitHub CLI

# Auth
gh auth login

# List
gh repo list
# gh repo list <owner>

# Update
gh repo edit owner/repository --description "Repository description"