是否建议将Git存储库名称设置为upper或camel而不是小写?

时间:2013-09-29 10:43:37

标签: git github naming-conventions

我看到很多项目为他们的GitHub存储库保留小写名称。

是否建议在大写字母或Camel案例中拥有存储库名称?
如果(是/否)为什么?

5 个答案:

答案 0 :(得分:51)

简短回答

this short article所示,一个好的命名惯例是:

  • 使用小写;
  • 用连字符分隔单词。

答案很长

据我所知,没有关于命名Git存储库的字母大小的标准惯例。

虽然其他VCS可能需要小写的存储库名称,但Git没有。因此,您可以自由地为您的存储库提供与项目/产品相同的名称(不包括空格和重音符号或任何其他依赖于系统的文本表示形式)。

对于多字词库,更喜欢连字符-来强调_ as GitHub engineers do,尽管它可能是GitHub无法处理大写时的继承。当然,您也可以使用PascalCase或camelCase。

然后,坚持小写的一个很好的理由是,存储库名称经常出现在URL中,这些URL可能不区分大小写,甚至可以转换为小写(例如,过去曾经发生过GitLab或Jira用户)。根据我的经验,我从未遇到过这样的限制,因此我对以大写字母开头的产品名称感到满意。

答案 1 :(得分:4)

首选连字符-以强调_

  • 易于输入
  • 更好的单词分隔符:尝试使用, Ctrl + Ctrl + ,光标将停止每个-,但不是_(取决于shell / word配置)

答案 2 :(得分:3)

也称为kebab-casePublic Sub CmdCreatePassword_Click() Dim i As Integer, j As Integer For i = 1 To 70 j = Int(Rnd(99) * 100) k = Int(Rnd(9)) Cells(i, "a") = UCase(Chr(97 + Int(Rnd(26) * 26)) & IIf(j < 10, j + 27, j) & IIf(k < 9, k + 9, k) & Chr(122 - Int(Rnd(26) * 26))) Next i End Sub 。易于键入,易于阅读。

答案 3 :(得分:0)

根据我的经验,我建议坚持使用小写和连字符。当我们的管道库代码在docker image标签中使用git org name和repo name时,我们遇到了一个问题。 如果您的组织/存储库名称包含大写字母,那么您将遇到类似

的错误

“无效的引用格式:存储库名称必须为小写(错误请求:400)”。
如果您没有计划在docker image标签中使用它们,那么可以,但是将其大写表示限制了您的选择。

答案 4 :(得分:0)

从我在GitHub上看到的内容以及从各个网站上阅读的内容来看,它似乎都是小写字母,连字符似乎很受欢迎。我更喜欢在项目中使用“ ProjectName”,因为它看起来更干净。