Github项目结构

时间:2017-10-14 16:02:27

标签: git github go project-structure

我只是写了一些分为3个部分的项目:用Golang编写的API,mongoDB和android客户端。如上所述,我认为创建指令会很好。但是当golang github项目不是很好的做法时:对于这样的结构:

MyProject
├── API
│   ├── scripts
│   └── src
│       └── some_go_file.go
├── DB
│   ├── db_scripts
│   └── data
└── AndroidDirectory

知道这个结构应该是什么样的吗?我应该使用单独的回购,还是应该将每个组件留在单独的分支上?

1 个答案:

答案 0 :(得分:2)

github上的Go项目没有特别的布局,除了通过在顶层有一个包含一些go文件的主包来让它变得可以很好。请参阅此处的说明,但请记住,首先是谈论工作区,而不是应用程序,如果向上滚动。

https://golang.org/doc/code.html#Command

  

要编译并运行一个简单的程序,首先选择一个包路径   (我们将使用github.com/user/hello)并创建相应的包   工作区内的目录:

     

$ mkdir $ GOPATH / src / github.com / user / hello接下来,创建一个名为的文件   hello.go在该目录中,包含以下Go代码。

这是我唯一改变的地方 - 在顶层放置至少一个go文件,然后你可以将你的其他软件包放在你想要的任何结构之下(它的结果)如果你想要大多数包,可以使用src目录。

为Android项目使用单独的repo,因为它不太可能使用相同的代码(可能它会通过网络使用API​​,并且不会直接使用mongodb)。

离开你的api项目和mongodb。由于数据库数据和任何脚本都可能与api服务器相关并且随之发展,因此我将它们作为您所展示的项目的子目录。