当你在GitHub上创建存储库时,你可以选择创建存储库的描述。不幸的是,我编写的描述不再充分描述回购中的代码。

如何更改回购描述?


当您将鼠标悬停在现有的描述上时,一个Edit按钮将出现在最左侧。


当您将鼠标悬停在描述和项目url部分上时,单击Edit


他们稍微改变了外观,“编辑”按钮是在存储库主页上看到的,这是“代码”选项卡。这是一个截图/动画截图:


以防其他人有和我类似的问题……

在提交和推送一个或多个文件之前,不能编辑描述。在我的特定情况下,我从IntelliJ IDEA创建了存储库,并意外地用我打算用于第一次提交的文本填充了描述。但是,我实际上并没有提交或推送任何文件。

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


截至2020年,如果你在功能预览中选择了新设计,可以通过点击右侧菜单“关于”部分的齿轮图标来更改关于存储库的元信息:

这样做后,将出现一个弹出窗口,其中可以配置描述,网站,主题和主页设置:


1.进入您的存储库。

2.右边是关于和设置的符号。

3.单击设置。

4.您将获得Edit存储库详细信息。

5.你可以改变细节。


你可以直接从命令行这样做,而不必与GitHub网站交互。

从GitHub CLI的gh 2.4.0开始,你可以使用gh repo编辑:

gh repo edit d, --description <string>

# Update the description of the repository

如图所示,单击齿轮图标,然后更改存储库描述

点击“保存更改”


按下齿轮按钮,你会看到描述更新或删除它


截至2023年,Github UI再次更新,该选项现在位于存储库页面的右上角。点击About旁边的齿轮图标,一个新的模式将会弹出,你可以在其中更改存储库的描述。