Android Studio项目应该提交哪些文件到GitHub上?
Google过,没有找到满意的答案,想问问各位大神们在把Android Studio的项目提交到GitHub的时候一般忽略哪些文件,提交哪些文件,以及…
关注者
361被浏览
43,94916 个回答
弄清楚你把代码上传到github的目的是什么,自然而然就知道上传些什么了,可以把开源项目想象成一款产品,如果你是用户,你需要什么。
上传到github肯定是想开源你的代码,首先别人clone你的代码导入到IDE能够立马使用,不用任何额外的配置那是最好不过的事情;其次别人查阅你的代码时,能够很容易地读懂。
所以:
- 如果你的项目有设计文档、类图、单元测试、说明文档什么的,应该放进去;如果你为项目写了更新日志,有每次更新的记录,也应该放进去;文档类的东西可以在项目中建立一个doc文件夹,专门放这些;
- 如果你依赖了第三方库,建议也放进去,这会给使用这个项目的人带来极大地方便;
- 如果你的项目可以导成jar包独立使用,建议放一份独立的jar包;
- 其它就是基本的一些东西:项目源码
其实你可以看一下github上流行的开源项目,他们是怎么做的;或者看一下用AS创建项目时,默认的.gitignore中过滤掉了哪些文件;起码编译生成的文件是不会上传的,因为用户拿到你的代码,在运行之前肯定会先编译,上传编译生成文件白白占用了github的存储空间。
补一刀,可以看下StackOverflow上的这个回答:
http://stackoverflow.com/questions/16736856/what-should-be-in-my-gitignore-for-an-android-studio-project