How to update a repository description?

 

Step 1: Sign in to GitHub

 

Open your preferred web browser and navigate to https://github.com. Enter your GitHub username or email address and your password, then click Sign in.

 

Step 2: Navigate to the target repository

 

In the top-right corner of any page, click your profile photo to open the dropdown menu. Select Your repositories. From the list of repositories, click the name of the repository whose description you want to update.

 

Step 3: Locate the repository description field

 

On the repository’s main page, just below the repository name, you will see the current description or a placeholder labeled Add a description. To the right of this text, there is a pencil icon for editing the description.

 

Step 4: Edit the description inline

 

Click the pencil icon next to the description. The description area will turn into an editable text field where you can type your new description.

 

Step 5: Enter the new description

 

Click inside the editable text field and type your new repository description. Keep it concise and informative—GitHub supports up to 100 characters in this field.

 

Step 6: Save your changes

 

Once you’ve entered your new description, press Enter or click anywhere outside the text field. Your changes will be saved automatically, and the updated description will appear immediately.

 

Alternative Method: Using the Settings Tab

 

If you prefer to update the description from the repository settings page, follow these steps:

• Click the Settings tab near the top of the repository page.
• Under the Options section, find the Description input field.
• Type or modify your description text.
• Scroll down and click Save changes.

 

Alternative Method: Using GitHub CLI

 

If you have the GitHub CLI installed and authenticated, you can update the repository description directly from your terminal with the following command:

gh repo edit username/repository-name --description "New repository description"

Replace username/repository-name with your GitHub username and repository name, and update the text inside quotes to your desired description.