如何在GitHub上更改存储库描述?

288
当您在GitHub上创建一个代码库时,可以选择创建该代码库的描述。不幸的是,我写了一个不再充分描述该代码库中代码的描述。
如何更改代码库的描述?
10个回答

215

他们稍微改变了外观,当在存储库的主页面(即“代码”选项卡)时,可以看到“编辑”按钮。以下是屏幕录像/动画截图:

输入图像描述


8
对于像我这样的 GitHub 新手来说,这是我见过的最令人困惑的已接受解决方案。根据我的理解:1)悬停(在哪里?)根本没有任何相关作用。2)截图中的附加组件与此无关。我敢打赌截图的意图是要指出“- Edit”后缀,它充当按钮。对于新手来说很明显,他们不会去搜索并进入这个问题,所以你能够到达这里的原因是:3)它并不总是可见,就像 Sergio 在上面的评论中提到的那样。它只会在将其添加到最初创建的存储库后才会显示出来(或类似于此的操作)。 - Stein
3
如果您看不到它,请确保您登录的帐户具有对该仓库的贡献权限。 - Noumenon
2
你在上传到imgur之前使用了哪些工具来创建那个视频? - FiringBlanks
1
@FiringBlanks 我使用了Camtasia Studio。 - Noitidart
3
外观又改变了。在右上方寻找设置齿轮,如其他答案中所提到的。 - Jeff Learman
显示剩余2条评论

124
在右侧菜单的“关于”部分,点击齿轮图标可以更改有关存储库的元信息。

2020 design: edit cog

在这样做之后,将会弹出一个窗口,您可以在其中配置描述、网站、主题和主页设置。

2020 design: edit popup


26
注意:只有在您的存储库中有一个或多个文件时,您才能访问此内容!请注意。 - kasimir
1
@kasimir - 嗯,是的,有点没变,这里的其他答案在这方面仍然是正确的。 - Oleg Valter is with Ukraine
3
没错,这就是我点赞的原因 :-) 上面的回答和截图非常准确 - 前提是您在存储库中有一个或多个文件,我只有在阅读下面的答案时才意识到这一点。 - kasimir
1
@kasimir - 我认为编辑空的仓库描述和元数据并不是很有用,但是我同意这肯定是一个很好的功能 - 毕竟,为什么要依赖于仓库中是否有文件呢?某些事情告诉我,在更改传统用户界面时,这是一个疏忽(毕竟,空仓库布局没有太大变化)。 - Oleg Valter is with Ukraine
5
在我的情况下,我正在为其他开发人员设置一些空仓库,并尝试在描述中传达每个仓库的目的。然而,我犯了一个错误(两次使用相同的描述),无法更正,这使得开发人员感到困惑。然后我不得不放置一个虚拟文件来纠正我的错误,但这并没有提供最佳的用户体验... - kasimir
显示剩余2条评论

106

当你将鼠标悬停在描述和项目网址部分上时,点击出现的Edit按钮。

图片描述


48
他们需要改变这个。我不得不去Stack Overflow寻求答案的事实令人震惊。谢谢。 - Adam Waite
26
显然,只有在项目不为空时才会在项目的详细信息中出现描述!我必须提交一些内容才能进行更改。 - Sergio
是的,那是最令人困惑的部分,我创建了一堆空仓库来移动几个项目。>< - Clarence Liu

56
当你将鼠标悬停在当前描述上时,最左边会出现一个“编辑”按钮。

在此输入图片描述


50

如果有人和我一样遇到了相似的问题……

在提交和推送一个或多个文件之前,你无法编辑描述。 在我的情况下,我是通过 IntelliJ IDEA 创建仓库,并不小心将我打算用于第一次提交的文本填入了描述中。但是,我实际上没有提交或推送任何文件。

我转到 GitHub 网站上的仓库页面,在那里我可以从仓库页面看到仓库及其描述。但是,在查看单个仓库页面时,描述不会出现,而设置项目的建议则是唯一显示的内容。没有明确的指示表明在上传文件之前无法编辑描述,但一旦你这样做了,描述就会清晰地显示出来,并附带一个编辑链接。


47
用户体验非常糟糕。仓库描述完全可以放在仓库设置页面,没有任何理由不这样做。 - Luke
3
我再怎么强调也不为过。 - Marc.2377

17

在此输入图片描述

点击与上图相同的齿轮图标,然后更改您的代码库描述

在此输入图片描述

点击“保存更改”


请问您能否在图片中概括步骤的描述?这样可以让每个人都能够理解(例如,考虑到屏幕阅读器)。 - aaossa
1
请注意,如果存储库为空/没有提交,则此齿轮图标不可见。 - hotdogsoup.nl
这个相同的答案已经在此之前多次给出过。而且,对于看不到图片的人来说,这个答案完全没有用处。 - undefined

11

1. 进入您的代码库。

2. 在右侧可以看到"关于(About)"和"设置(setting)"的图标。

关于和设置

3. 点击设置。

4. 您将进入编辑代码库详情页面。

5. 您可以更改详细信息。

编辑说明


显然这只适用于公共存储库。我们不能对私有存储库做同样的事情吗? - Hadi KAR
@HadiKAR 它可以在我的私人存储库上运行。只有对于空的存储库,我才无法这样做。 - joanis
这个答案在这个之前已经存在了几个月,而且内容完全一样。 - undefined

6
你可以直接从命令行执行此操作,无需与 GitHub 网站交互。
GitHub CLI gh 2.4.0 版本以来,你可以使用 gh repo edit 命令:
gh repo edit --description="your_description"

# Update the description of the repository

5
截至2023年,Github的用户界面已经再次更新,现在选项位于存储库页面右上角。点击“关于”旁边的“齿轮图标”,将弹出一个新的对话框,在其中可以更改存储库的描述。 enter image description here

这与已经存在的答案没有任何区别。 - undefined

2

来自此齿轮按钮

点击齿轮按钮,您将看到更新或删除其描述的选项。


这个解决方案已经在这里给出了,而且对于无法看到图片的人来说,这个答案是无用的。 - undefined

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接