如何更改 GitHub 上的存储库描述？

Posted 2023-03-05

【中文标题】如何更改 GitHub 上的存储库描述？

【英文标题】：How do you change a repository description on GitHub?

【发布时间】：2011-10-13 17:05:23

【问题描述】：

在 GitHub 上创建存储库时，您可以选择创建存储库的描述。不幸的是，我写的描述不再充分描述 repo 中的代码。

如何更改 repo 描述？

【参考方案1】：

他们稍微改变了外观，在存储库主页上可以看到“编辑”按钮，即“代码”选项卡。这是一个截屏视频/动画截图：

【讨论】：

对于像我这样的 github 新手来说，这是我见过的最令人困惑的公认解决方案。据我说，1）悬停（在哪里？）根本没有做任何相关的事情。 2）截图上的插件无关。我敢打赌，截图打算指出“-编辑”后缀，它充当一个按钮。很明显，新手不会去搜索并解决这个问题，所以你在这里登陆的原因是：3）它并不总是可见的，正如 Sergio 在上面的评论中指出的那样。它仅在添加到最初创建的存储库（或类似的东西）后才会出现。

如果您没有看到它，请确保您登录的帐户可以为该 repo 做出贡献。

在上传到 imgur 之前，您使用了哪些工具来创建该视频？

@FiringBlanks 我用的是 Camtasia Studio

外观又变了。如其他答案所述，在右上角查找设置齿轮。

【参考方案2】：

当您将鼠标悬停在描述和项目 url 部分时，单击出现的 Edit

【讨论】：

他们需要改变这一点。我不得不求助于 Stack Overflow 来寻找答案的事实令人震惊。谢谢

显然，如果项目不为空，描述只会出现在项目的详细信息中！。我必须先提交一些东西才能更改它。

是的，这是最令人困惑的部分，我正在创建一堆空的仓库来移动一些项目>

【参考方案3】：

从 2020 年起，如果您在功能预览中选择了新设计，则可以通过单击右侧菜单“关于”部分中的齿轮图标来更改有关存储库的元信息：

执行此操作后，将出现一个弹出窗口，可以在其中配置描述、网站、主题和主页设置：

【讨论】：

注意：只有在您的仓库中有 1 个或多个文件时，您才能访问此文件！

@kasimir - 嗯，是的，有点保持不变，other answer here 在这方面仍然是正确的。

是的，这就是为什么我赞成那个:-) 上面的答案+屏幕截图是正确的——前提是你的仓库中有一个或多个文件，我只有在阅读下面的答案时才知道。

@kasimir - 我认为编辑空的 repo 描述和元数据没有那么有用，但是我同意拥有它肯定会很好 - 毕竟，它为什么要依赖在回购中有文件？有人告诉我这是更改旧版 UI 时的疏忽（毕竟，空的 repo 布局没有太大变化）

在我的例子中，我为其他开发人员设置了一些空的 repos，并试图在描述中传达每个 repo 的目的。但是，我犯了错误（两次使用了相同的描述）并且无法更正它，这让开发人员感到困惑。然后我不得不在里面放一个虚拟文件来纠正我的错误，这并没有提供最好的用户体验......

【参考方案4】：

当您将鼠标悬停在现有说明上时，Edit 按钮将出现在最左侧。

【参考方案5】：

以防万一其他人和我有类似的问题......

在提交并推送一个或多个文件之前，您无法编辑描述。在我的具体情况下，我从 IntelliJ IDEA 创建了存储库，并且不小心用我最初打算使用的文本填充了描述犯罪。但是，我实际上并没有提交或推送任何文件。

我访问了 GitHub 网站上的存储库页面，在那里我可以从存储库页面看到存储库及其描述。但是，在查看单个存储库页面时，不会出现描述，并且设置项目的建议是唯一显示的内容。没有明确的迹象表明您在上传文件之前无法编辑说明，但是一旦您这样做了，说明就会清楚地显示出来，并带有一个编辑链接。

【讨论】：

这是一个完全混乱的用户体验。绝对没有理由不将存储库描述仅显示在存储库设置页面上。

/\我怎么强调都不过分。

【参考方案6】：

1.进入您的存储库。

2.右侧关于设置和符号。

3.点击设置。

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

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

【讨论】：

显然这只适用于公共回购。我们不能对私人回购做同样的事情吗？

@HadiKAR 它适用于我自己的私人仓库。只有空的回购，我不能这样做。

【参考方案7】：

您可以直接从命令行执行此操作，而无需与 GitHub 网站交互。

由于GitHub CLI gh 2.4.0，你可以使用gh repo edit：

gh repo edit d, --description <string>

# Update the description of the repository

【参考方案8】：

点击图片中的齿轮图标，然后更改您的存储库描述

点击“保存更改”

【讨论】：

能否请您描述一下图片中列出的步骤？可能不是每个人都能理解（例如，想想屏幕阅读器）