在git存储库中管理项目文档

时间:2012-11-15 17:29:58

标签: git documentation

我目前正在与一些人合作开展一个项目,我想知道什么是分享项目文档的最佳方式。我正在考虑在某些文件夹中添加文档并将其添加到git中,但我真的不知道如何以正确的方式执行此操作...

我们尝试按照git repo的这个操作方法:http://nvie.com/posts/a-successful-git-branching-model/

我认为这是管理git仓库的一种非常常见的方式:版本的主人,为即将推出的功能开发,每个功能一个分支......但我没有看到任何方式包含和处理文档与这个模型。我应该为doc创建一个特定的分支吗?我应该在开发中推送它然后每次在功能分支中合并它吗?我有点失落......

感谢您的帮助: - )

1 个答案:

答案 0 :(得分:0)

您可能希望功能的文档与功能本身同时合并。对我而言,这表明您应该在编辑代码的任何分支中处理文档。

因此,我建议您使用docs目录(如您在问题中所述),并在功能分支中更新它。这样,如果您决定不合并该功能,那么您不会意外地合并附带的文档。

develop 分支中执行它没有多大意义,因为它是一个集成分支。所以你希望在那里合并,但不要在那里进行实际开发(包括编写文档)。

  

我应该为doc创建一个特定的分支吗?

如果你的意思是创建一个只包含文档的分支,那么不,我认为这是一个坏主意。能够同时检出代码和文档是有用的,如果你需要检查两个分支,那就更难了。

如果你的意思是创建一个特定的分支来处理文档,那么可能是的。如果您将文档称为功能,那么使用功能分支(或类似的不同名称)可能是有意义的。