question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

New repo: Add description field

See original GitHub issue

Description

The New Repository dialog is almost just like on the web, except that it lacks a description input field. I’ve included screenshots at the bottom of this post to juxtapose the two.

I understand the input of the description field to go to two places upon creation of a repo on the web:

  • The description field below the repo title
  • The line below the title in README.md if “Initialize this repository with a README” is selected before selecting “Create repository”.

It is also my understanding that the description field is specific to GitHub.com repositories, as it does not go into the .git/description file for gitweb, as discussed in isaacs/github#485. However, it would be convenient to avoid having to utilize the website to manually input the repo description after publishing a new repo.The desktop client could handle this by doing the following:

  1. Allow the user to input a description string below the title (like on the web)
  2. Save it somewhere until the user publishes the repo (someone on the team will know the best location for this—maybe there’s already a place—but if not, perhaps at .git/info/gh-description?)
  3. As a step of publishing the repo, set the description field of the repo to the user-input string

If this is implemented, then the repo creation for desktop will be in complete parity with the web. 🙌

Version

GitHub Desktop version: 0.8.2

OS version: macOS 10.12.6

Screenshots

Desktop:
desktop

Web:
web

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Comments:8 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
joshabercommented, Sep 14, 2017

And indeed, that’s exactly what @davidcelis did in https://github.com/desktop/desktop/pull/2723 😆

0reactions
joshabercommented, Sep 14, 2017

Nope, no worries!

Read more comments on GitHub >

github_iconTop Results From Across the Web

How do you change a repository description on GitHub?
9 Answers 9 · 1.Go into your repository. · 2.On the right side About and symbol of setting. About and Setting · 3.Click...
Read more >
How to change the repository description?
If you go Settings -> Repository Details you should see an editable description field. I hope that helps!
Read more >
Migrate a Git repository to AWS CodeCommit
The description field displays Markdown in the console and accepts all HTML characters and valid Unicode characters. If you are an application developer...
Read more >
package.json - npm Docs
If you don't plan to publish your package, the name and version fields are optional. ... New packages must not have uppercase letters...
Read more >
Description templates - GitLab Docs
Similarly to issue templates, create a new Markdown ( .md ) file inside the .gitlab/merge_request_templates/ directory in your repository. Commit and push to ......
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found