When you create a repository on GitHub, you can optionally create a description of the repository. Unfortunately, I wrote a description that no longer adequately describes the code in the repo.
How do I change the repo description?
They changed the looks slightly, the "Edit" button is seen when on the repositories main page, which is the "Code" tab. Here is a screencast/animated-screenshot:
As of 2020, if you chose the new design in feature preview, meta-information about the repository can be changed by clicking on a cog icon in the right-hand side menu's "About" section:
Upon doing so, a popup will appear where the description, website, topics, and homepage settings can be configured:
Click on the Edit that comes when you hover your mouse over the description and project url section
When you hover over the existing description, an Edit button will appear at the far left.
Just in case anyone else has a similar issue as me...
You cannot edit the description until one or more files are committed and pushed. In my specific case, I created the repository from IntelliJ IDEA and accidentally filled the description with text I had intended for the first commit. However, I didn't actually commit or push any files.
I went to the repositories page on the GitHub website, where I could see the repository and its description from the repositories page. However, when viewing the individual repository page, the description would not appear and suggestions for setting up the project were the only content displayed. There is no clear indication that you cannot edit the description until a file is uploaded, but once you have done so, the description is clearly displayed and with it a link to edit.
Click on the gear icon like in the image, and then change your repository description
Click "Save Changes"
1.Go into your repository.
2.On the right side About and symbol of setting.
3.Click on the setting.
4.You get Edit repository details.
5.you can change details.
You can do so directly from command-line, without having to interact with GitHub website.
Since the GitHub CLI gh 2.4.0, you can use gh repo edit:
gh repo edit d, --description <string>
# Update the description of the repository
press the Gear Button and you will see the description to update it or delete it
As of 2023, Github UI has been updated again and the option is now located in the top-right corner of a repository page. Click on the Gear Icon next to About, and a new modal will pop up where you can change the description of the repository.
Related
I have just created a new repository in GitHub and I wanted to change the Readme file, however the "Commit Changes" button is just greyed out, as shown below.
As well as this, when I click on "Preview" to view how it would look with Markdown, nothing happens, it just stays on the "Edit File" tab. Why is this not working?
Try disabling adblockers. I found this post on github community I tried toggling my adblockers and found it was ghostery breaking the site.
Edit: Ghostery specifically breaks the page by blocking Adobe Experience Cloud. This can be resolved by either setting the github site as trusted or by enabling that tracker on the github site (as I've done).
I'm looking to test out github releases.
The guidance says:
On GitHub, navigate to the main page of the repository.
To the right of the list of files, click Releases or Latest release.
However, when I do this there is no "Releases" or "Latest release" button.
Is there some obvious configuration I need to do to the repo first?
Click on "tag" (you will find it at top left next to branches or search for it using Ctrl-F tag)
or simply go to https://github.com/USERNAME/REPO/releases.
Click on "Draft a new release".
Follow the guidance from step 4.
I need to change the default branch of my GitHub repository in order to delete it (it was somehow set to default upon uploading a file in which some documents were missing). In other words, I need to upload it again but I can't delete it as is the default...
I don't have the settings option as instructed in the help page. GitHub support never answered my request.
Much thanks for your help
First - check to see that you are the owner of the repository, or that you have sufficient permissions.
1.On GitHub, navigate to the main page of the repository.
2.Under your repository name, click Settings.
3.In the left menu, click Branches.
4.In the default branch sidebar, choose the new default branch.
You can only switch between branches that already exist on GitHub.
EDIT:
If you are missing the Settings button try
Ctrl+F5.
If that doesn't work clearing the cache and cookies (I'd suggest to just try a different browser).
I've been reading many tutorials, trying to figure out easy steps to the workflow for contributing to a GitHub repository using GitHub itself (I'm a Windows programmer, so I find the local git CLI extremely awkward, as well as much more complicated than working entirely remotely in GitHub).
I will post the steps as I discover and develop them in the answer below.
Please, I cannot do this on my own, as I barely know what I'm doing. Suggest edits to my answer, or post comments and I will edit.
Easy steps to contribute to an existing GitHub repository:
If there is not already an Issue posting describing the problem or code change, create one on the GitHub repository (repo) in the Issues section.
Create your own GitHub account, if you do not have one.
Go back to the GitHub repository (repo) and click the "Fork" button. This will create a copy of the entire repo in your account as your own repo with the same repo name.
In your new repo on GitHub, click on the button "Branch: master". Enter a name of your new branch (include the issue number) and press Enter to create a new branch for your changes.
In your new repo and your new branch, click on the file you wish to edit or click the "Create new file" button. Make your changes.
When you are happy with your changes, scroll down to the "Commit new file" section. The title can be something like "Created file FILENAME". Add a description of your changes, including the issue number. Click "Commit new file" button to commit your change before testing it. Repeat for any additional files.
At the repo (Code section), click the green "Clone or download" button. Download a zip file to use locally to build if needed and test your changes locally.
At the repo (Code section), you should now see a notice, "Your recently pushed branches:". This means that your edits in your own repo created a "recently pushed branch". Inside this notice is a green button "Compare & pull request". Take a deep breath and push it. You will now be at the "Open a pull request" page. This will automatically request that the owner of the repo accept your changes.
If you see a "checklist", edit it to reflect your work so far. Otherwise, describe your changes in detail, referencing the associated Issue posting.
Click the green "Submit pull request" button. This posts your entry in a conversation about this request. If there are no edit conflicts, you should also see a green checkmark icon and the words "This branch has no conflicts with the base branch".
Wait for a response from the repo owner.
This is as far as I've gotten.
When you create a repository on GitHub, you can optionally create a description of the repository. Unfortunately, I wrote a description that no longer adequately describes the code in the repo.
How do I change the repo description?
They changed the looks slightly, the "Edit" button is seen when on the repositories main page, which is the "Code" tab. Here is a screencast/animated-screenshot:
As of 2020, if you chose the new design in feature preview, meta-information about the repository can be changed by clicking on a cog icon in the right-hand side menu's "About" section:
Upon doing so, a popup will appear where the description, website, topics, and homepage settings can be configured:
Click on the Edit that comes when you hover your mouse over the description and project url section
When you hover over the existing description, an Edit button will appear at the far left.
Just in case anyone else has a similar issue as me...
You cannot edit the description until one or more files are committed and pushed. In my specific case, I created the repository from IntelliJ IDEA and accidentally filled the description with text I had intended for the first commit. However, I didn't actually commit or push any files.
I went to the repositories page on the GitHub website, where I could see the repository and its description from the repositories page. However, when viewing the individual repository page, the description would not appear and suggestions for setting up the project were the only content displayed. There is no clear indication that you cannot edit the description until a file is uploaded, but once you have done so, the description is clearly displayed and with it a link to edit.
Click on the gear icon like in the image, and then change your repository description
Click "Save Changes"
1.Go into your repository.
2.On the right side About and symbol of setting.
3.Click on the setting.
4.You get Edit repository details.
5.you can change details.
You can do so directly from command-line, without having to interact with GitHub website.
Since the GitHub CLI gh 2.4.0, you can use gh repo edit:
gh repo edit d, --description <string>
# Update the description of the repository
press the Gear Button and you will see the description to update it or delete it
As of 2023, Github UI has been updated again and the option is now located in the top-right corner of a repository page. Click on the Gear Icon next to About, and a new modal will pop up where you can change the description of the repository.