How to update Description on my repository?

[mikadarmawijaya00000]

Select Topic Area

Question

Body

How to update Description on my repository?

[denitiawan]

Step by step for update the Description on repository :

• go to your repository
• click setting button on "top right"
• and then type on "description" input text
• click button "save changes"

finally your repo got new description

[osparking]

This should be the respected answer.

[sean-abbott]

+1

[Stratxgy]

@KalHal123 Try this. Go to the main page of your repo and click the gear icon I'm pointing to with the magenta arrow in this screenshot. That should bring up a settings window where you can add your description.

Correct answer.

[ScottMonolith]

Hm, I have the 'Settings' with the gear icon but I do not have this little gear on the far right...

On another repo I see that icon - perhaps because the new repo was initialized and has not been populated with any data yet? Seems odd that I can't change the description until something is uploaded to the repo...

[marckruzik]

@ScottMonolith Yes, the "About" cog wheel does not appear if the repo is empty.
See https://github.com/orgs/community/discussions/54372#discussioncomment-6830666

[eduardolbruno]

Simple step by step if someone is in the same scenario:

• Open your repo
• Click “Settings” button
• Type on "description" input text all the info you want to show.
• Don’t forget to "save changes"

Thats all! Also, you can change it anytime. It doesn’t affect your contributions or any progress related to that repo.

[0dayhunter]

To update the description of your repository on GitHub, follow these steps:

1. Log In: Make sure you're logged in to your GitHub account.

2. Navigate to Repository:

   • From your GitHub dashboard, click on the repository you want to update the description for.

3. Access Settings:

   • In the repository, click on the "Settings" tab located on the right side of the repository menu.

4. Edit Description:

   • On the left sidebar of the settings page, you'll find a field labeled "Repository name" and below it, the "Description" field.
   • Click on the "Edit" button (pencil icon) next to the repository description.

5. Update Description:

   • Enter the new description for your repository in the provided text box.

6. Save Changes:

   • After updating the description, scroll down to the bottom of the page.
   • Click the "Save changes" button to save your updated repository description.

7. Verify Changes:

   • Go back to your repository's main page to see the updated description displayed under the repository name.

That's it! Your repository description should now be updated with the new information you provided. Remember that the repository description is a short summary that helps others understand the purpose or content of your repository.

[UTandor]

For some reason, it says this in the embed of my repo instead of the description:
"Contribute to username/repo development by creating an account on GitHub." instead of the description of the project

[Afrin127329]

Thanks. Helped a lot

[rla]

The settings button for this is missing when there are no commits in the repository.

[hassanbasri]

yep, same

[jaredperrin]

I don't see any way to modify the description from the area being described here. Attached is a screenshot from the "Settings" tab - it does not appear there is any way to change the description from here. What am I missing?

[reza-nzri]

Thanks a bunch! ❤️

[09anushkam]

Thanks it helped!

[Modak-NeelKamal]

thank you

[doorkaz]

Well, keeheung, you don't know why, but, i created a new project and that button doesn't appears, so, it's completely not your problem, it's a problem of design of the app. Because "settings" also should give the option to change the description.

[ScottMonolith]

@doorkaz - evidently if the repo is empty you can't change the description... seems like a pretty big miss / bug to me, but what do I know.

https://github.com/orgs/community/discussions/54372#discussioncomment-10987548

[balusena]

Response #2

[erwinkramer]

It's not possible to change the description of a repo in the mobile version of the website 👎

[TheGiraffe3]

If you scroll down to the very bottom, the settings button you’re looking for should be on the right.

[ShanyMargalit]

Hi, I'm on desktop. [image: Mailtrack] <https://mailtrack.io?utm_source=gmail&utm_medium=signature&utm_campaign=signaturevirality11&> Sender notified by Mailtrack <https://mailtrack.io?utm_source=gmail&utm_medium=signature&utm_campaign=signaturevirality11&> 18.06.24, 02:39:11 ‫בתאריך יום ב׳, 17 ביוני 2024 ב-6:26 מאת ‪Loymdayddaud‬‏ <‪ ***@***.***‬‏>:‬

…

@ShanyMargalit <https://github.com/ShanyMargalit> are you on mobile or a desktop? — Reply to this email directly, view it on GitHub <#54372 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BHDHNL672XRUJPDM6UHFEU3ZHZJNTAVCNFSM6AAAAAAXUVN5DOVHI2DSMVQWIX3LMV43SRDJONRXK43TNFXW4Q3PNVWWK3TUHM4TOOBZHAYDM> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[TheGiraffe3]

Check above then.

[ShanyMargalit]

HiHi, you probably didn't understand my question. I want to add a description to a repository that doesn't currently have a description. What you sent me, is to edit a description that already exists, so it's not relevant to me. Can you help me how to add a description to the repository? [image: Mailtrack] <https://mailtrack.io?utm_source=gmail&utm_medium=signature&utm_campaign=signaturevirality11&> Sender notified by Mailtrack <https://mailtrack.io?utm_source=gmail&utm_medium=signature&utm_campaign=signaturevirality11&> 18.06.24, 12:39:48 ‫בתאריך יום ג׳, 18 ביוני 2024 ב-6:39 מאת ‪Loymdayddaud‬‏ <‪ ***@***.***‬‏>:‬

…

If you scroll down to the very bottom, the settings button you’re looking for should be on the right. — Reply to this email directly, view it on GitHub <#54372 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BHDHNLYQANPLL2EYHGY2CODZH6TWDAVCNFSM6AAAAAAXUVN5DOVHI2DSMVQWIX3LMV43SRDJONRXK43TNFXW4Q3PNVWWK3TUHM4TQMBRGE2TM> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[juddydev]

I created a repo without the description
But I'm going to try to add description in old repo, but I cant find "description" button
Please help me this issue

[ShanyMargalit]

That's my question, also!! I don't know what to do!! If somebody has a solution, please help me. thanks. [image: Mailtrack] <https://mailtrack.io?utm_source=gmail&utm_medium=signature&utm_campaign=signaturevirality11&> Sender notified by Mailtrack <https://mailtrack.io?utm_source=gmail&utm_medium=signature&utm_campaign=signaturevirality11&> 20.06.24, 11:49:08 ‫בתאריך יום ה׳, 20 ביוני 2024 ב-9:51 מאת ‪DcorpProj‬‏ <‪ ***@***.***‬‏>:‬

…

thanks you — Reply to this email directly, view it on GitHub <#54372 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BHDHNLZFBBM4AQDXQNP6RELZIJ3XVAVCNFSM6AAAAAAXUVN5DOVHI2DSMVQWIX3LMV43SRDJONRXK43TNFXW4Q3PNVWWK3TUHM4TQMRVGEYDC> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[fastoch]

On the web app: after opening your repo, you should see a gear icon at the top right

[ShanyMargalit]

I see this gear, but there is no option to add a description. I'll point out again, I opened a repository without adding a description to it, and now when I want to add, it can't be done through the repository's settings [image: Mailtrack] <https://mailtrack.io?utm_source=gmail&utm_medium=signature&utm_campaign=signaturevirality11&> Sender notified by Mailtrack <https://mailtrack.io?utm_source=gmail&utm_medium=signature&utm_campaign=signaturevirality11&> 20.06.24, 12:55:12 ‫בתאריך יום ה׳, 20 ביוני 2024 ב-12:12 מאת ‪Fastoch‬‏ <‪ ***@***.***‬‏>:‬

…

after opening your repo, you should see a gear icon at the top right — Reply to this email directly, view it on GitHub <#54372 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BHDHNL4TZNGZT5Q2C7L4QM3ZIKMJVAVCNFSM6AAAAAAXUVN5DOVHI2DSMVQWIX3LMV43SRDJONRXK43TNFXW4Q3PNVWWK3TUHM4TQMRWG4YDO> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[ShanyMargalit]

And I have another small question, every time I upload a commit, git writes that unknown uploaded the commit, and it doesn't recognize that it's me, even though I logged in through my personal account. someone has a solution? [image: Mailtrack] <https://mailtrack.io?utm_source=gmail&utm_medium=signature&utm_campaign=signaturevirality11&> Sender notified by Mailtrack <https://mailtrack.io?utm_source=gmail&utm_medium=signature&utm_campaign=signaturevirality11&> 20.06.24, 12:58:17 ‫בתאריך יום ה׳, 20 ביוני 2024 ב-12:55 מאת ‪Shani Margalit‬‏ <‪ ***@***.***‬‏>:‬

…

I see this gear, but there is no option to add a description. I'll point out again, I opened a repository without adding a description to it, and now when I want to add, it can't be done through the repository's settings [image: Mailtrack] <https://mailtrack.io?utm_source=gmail&utm_medium=signature&utm_campaign=signaturevirality11&> Sender notified by Mailtrack <https://mailtrack.io?utm_source=gmail&utm_medium=signature&utm_campaign=signaturevirality11&> 20.06.24, 12:55:12 ‫בתאריך יום ה׳, 20 ביוני 2024 ב-12:12 מאת ‪Fastoch‬‏ <‪ ***@***.***‬‏>:‬ > after opening your repo, you should see a gear icon at the top right > > — > Reply to this email directly, view it on GitHub > <#54372 (comment)>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/BHDHNL4TZNGZT5Q2C7L4QM3ZIKMJVAVCNFSM6AAAAAAXUVN5DOVHI2DSMVQWIX3LMV43SRDJONRXK43TNFXW4Q3PNVWWK3TUHM4TQMRWG4YDO> > . > You are receiving this because you were mentioned.Message ID: > ***@***.***> >

[Rudra-Sankha-Sinhamahapatra]

Hii @mikadarmawijaya00000 At first go the home page of the repo
You can see the settings icon on the top right corner ,click it
after that you can edit the desription

[ShanyMargalit]

You probably didn't understand my problem, my problem is not to edit a description, but to add a description that doesn't exist, I go into the gear and there is no description tab, my question is: how can you add a description to a repository that doesn't have a description? [image: Mailtrack] <https://mailtrack.io?utm_source=gmail&utm_medium=signature&utm_campaign=signaturevirality11&> Sender notified by Mailtrack <https://mailtrack.io?utm_source=gmail&utm_medium=signature&utm_campaign=signaturevirality11&> 20.06.24, 13:36:50 ‫בתאריך יום ה׳, 20 ביוני 2024 ב-13:34 מאת ‪Rudra Sankha Sinhamahapatra‬‏ <‪ ***@***.***‬‏>:‬

…

Screenshot.2024-06-20.160207.png (view on web) <https://github.com/community/community/assets/101992909/5a5e49bf-17d3-4341-90a8-62825453de65> At first go the home page of the repo You can see the settings icon on the top right corner ,click it after that you can edit the desription image.png (view on web) <https://github.com/community/community/assets/101992909/19d78542-281d-459f-9a0b-8bfbade94645> — Reply to this email directly, view it on GitHub <#54372 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BHDHNL2Z6QHHHBZ3UCA2ZK3ZIKV25AVCNFSM6AAAAAAXUVN5DOVHI2DSMVQWIX3LMV43SRDJONRXK43TNFXW4Q3PNVWWK3TUHM4TQMRXGQYTI> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[Rudra-Sankha-Sinhamahapatra]

Bro my repo dosent have a description clearly see it in the image

[fastoch]

Yes, everyone understood your problem. But as already stated, there should be a gear icon allowing you to add a description.
Your issue might be related to your Web browser. Have you tried another one?

[maxmos001]

[ar-sayeem]

Finally the "Top Right" setting button I found, THANKS A LOT <3

[ShanyMargalit]

OMG, thank you very much!!! I succeed to do it thanks all [image: Mailtrack] <https://mailtrack.io?utm_source=gmail&utm_medium=signature&utm_campaign=signaturevirality11&> Sender notified by Mailtrack <https://mailtrack.io?utm_source=gmail&utm_medium=signature&utm_campaign=signaturevirality11&> 20.06.24, 16:13:03 ‫בתאריך יום ה׳, 20 ביוני 2024 ב-14:50 מאת ‪M Ahmed Butt‬‏ <‪ ***@***.***‬‏>:‬

…

1-Go to your repository. 2-Click on the "Settings" button (top right). 3-Type in the new description in the "Description" input field. 4-Click the "Save changes" button. 5-Verify the updated description on the repository's main page. — Reply to this email directly, view it on GitHub <#54372 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BHDHNL5WI65KLIEAF2ZHUCTZIK6YLAVCNFSM6AAAAAAXUVN5DOVHI2DSMVQWIX3LMV43SRDJONRXK43TNFXW4Q3PNVWWK3TUHM4TQMRYGEYDS> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[BlumyLevintal]

[TheGiraffe3]

This is probably the wrong place.
That said, you look at the top right with the three buttons. Click it and press "Edit". Then you can type what you wanted to put in.

[aflacake]

Note: this cannot be done in repository private mode

[ShanyMargalit]

Hi Blumy!
Are you from Ashdod?,I think I know you...
Anyway, in the right side, you have gear, click there, and add your description.

[ShanyMargalit]

I was also sure that this button was not found, until someone attached a screenshot and beat me to it.[image: image.png] ‫בתאריך שבת, 27 ביולי 2024 ב-22:17 מאת ‪KalHal123‬‏ <‪ ***@***.***‬‏>:‬

…

Problem: Idk where y'all are seeing this "Description input field" when I go to settings not under any tab not general not *anywhere* I can find an input field where I can change the description!! I am on PC. I am in the menu everyone told me to. I am looking I even did the old Contro +F returned nothing. But for the love of god *I can not click into an Input field that does not exist for me, I'm sorry* Sorry if I come over a bit aggresive but I just hate this in software and coding in general when I am told by everybody to "jUsT pReSs ThAt BuTtOn" but the button is non-existent for me. If anyone wants me to prove it I'd go as far as to provide Screenshots. — Reply to this email directly, view it on GitHub <#54372 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BHDHNLZG2DO23N3OSEMCLD3ZOPW5PAVCNFSM6AAAAAAXUVN5DOVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTAMJWHA3TONI> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[aflacake]

Change private repository to public

The way to do this is to edit,
previously I wanted to edit the description because I forgot to set it at the beginning of creation
So i try it:

There are no description settings here

You need to do, set it to the settings in the repository

Change visibiliity and click "I want to make this repository public", click more another messages

It still doesn't appear, try adding a readme file or any file in your repository

Well now it's here

[marckruzik]

It has nothing to do with visibility. It is a GitHub bug related to empty repos.
I'm describing your steps with more details:

• You start with an empty repo.
• Empty repos have a special page "Quick setup" which is missing the right tab "About" with its gear icon to edit description.
• You change the visibility, which adds a "README.md" file in the repo.
• Because there is a file in the repo, the repo is no longer empty.
• The repo now displays the normal page, with the right tab "About" with its gear icon to edit description.

You can actually get the same result by doing the following (emphase on the step which replaces changing the visibility):

• You start with an empty repo.
• Empty repos have a special page "Quick setup" which is missing the right tab "About" with its gear icon to edit description.
• You add any file, by commiting it or using "/new/main" ( https://github.com/YourName/YourRepo/new/main ) (there are links in the Quick setup page to create them fast)
• Because there is a file in the repo, the repo is no longer empty.
• The repo now displays the normal page, with the right tab "About" with its gear icon to edit description.

I already reported this GitHub bug, but it's still there. This is confusing a lot of people.

My issue on this GitHub bug is here: https://github.com/orgs/community/discussions/43623

[tgrushka]

This is a major accessibility issue. I am legally blind and could not find "Description" in the settings anywhere. I use search on the page to find out how to do things. The gear icon is not accessible or helpful. This is a massive oversight!! How can one "find" a gear icon on the page? Not possible. It's totally visual, and not intuitive, even for a sighted person. One would expect to go into "Settings" to edit anything related to the repo. The tiny gear icon nearly hidden away is neither intuitive, nor helpful.