Suppose you notice a typo in your repo description or you didn’t specify one at the time you created the repo. To the far right, you’ll see an edit button.
Clicking this button allows you to edit a description and a website URL.
Give it a little while, but your repo description will end up on the GitHub.com search page when you do.
I’m sitting here wondering, “is this a useful tip?” but then I remember that feeling I felt when I (finally) found how to do it. Originally I thought I had to update a repo file somewhere, since it took me a while to get used to what files GitHub’s UI gets it’s info from (e.g. license) and what files are metatdata for the GitHub repo itself.
As you saw from previous posts, the UI on GitHub.com allows you to specify an optional extended message.
If you fill this optional extended description out,
you’ll see your extended description comments behind the `…` ellipsis.
Clicking the ellipsis shows the optional extended description.
How to do add the extended description from the command line
I’ve looked at a few stack overflow answers. There are answers using two -m arguments, using a literally formatted string (i.e. the ‘$’ at the start of the string), and using a vim editor. This also works for other editors I’ve played with.
For my examples right now, you’re watching me use Git Bash (i.e. Git Shell as setup from Desktop for Windows – I’ll cover more about Desktop for Windows in the upcoming tips).
Using the two -m arguments approach,
and pushing that up to GitHub, you’ll see the optional extended description under the ellipsis.
Old SDETs never die! What if I added 3 -m arguments?? What will GitHub do?
Looks like each extra -m adds a newline in the optional extended description, as shown on GitHub.com.