在本地与Github wikis合作

时间:2017-01-31 00:33:46

标签: git github wiki

我在Github上创建了一个新的repo并将其克隆到我的本地机器:〜/ org-name / repo-name

我想为该回购创建一个github wiki。我应该在哪里克隆它以在本地工作?

应该是:〜/ org-name / repo-name / wiki然后我可能会将wiki /中的所有内容添加到exclude / ignore列表中吗?或者嵌套git repo是不好的形式?不确定使用wiki是否有什么不同,因为它们与该回购连接。

如果答案是否定的,那么我假设我应该在与我的仓库相同的级别创建另一个名为〜/ org-name / repo-name_wiki的目录。

提前致谢,还在学习......

1 个答案:

答案 0 :(得分:1)

你可以拥有嵌套的Git repos,但我建议不要这样做。这是你不需要的复杂性。很容易忘记它们是两个独立的回购并且意外地使它们彼此依赖。你也很容易忘记你所在的目录,并开始在wiki中发出Git命令,认为你在源头,反之亦然。在源代码中有一个额外的子目录可能会破坏你的构建系统。

嵌套回购只应在彼此依赖的情况下完成,然后才能通过git submodule正式声明它。维基和源是相关的,但它们并不相互依赖。

我建议将源代码和wiki repos克隆到一个单独的目录中,可能在项目旁边。

projects/
    project-name/
    project-name-wiki/

或者在公共子目录下克隆项目源和wiki。

projects/
    project-name/
        src/
        wiki/

您选择的内容取决于您希望如何组织项目。