CODEWITHSUNDEEP
git
Zach Latta
Zach Latta

Reputation: 3341

Files to add to a git repository

I have a repository hosted on GitHub and I'm wondering which files should be pushed to it. Obviously my source files are added to it, but I'm not sure what to do about the libraries I'm using.

For example, I use this in my project. It's stored at /lib/ in my project directory. Should I include /lib/ in my repository?

Upvotes: 1

Views: 123

Answers (2)

Scott
Scott

Reputation: 1010

I would use a dependency management/build tool like Jenkins, npm, ant+ivy, etc... Then include that configuration and instructions. You want to make the barrier to contribution as low as possible. Even asking folks to download and coordinate versions themselves can be off putting. If I have the choice of contributing to two similar projects I will pick the one with a nice build system and dep management over the one that has none. Also include unit-tests =)

Since you appear to be using java, here is an example from a project I help with:

https://github.com/vngx/vngx-jsch

Upvotes: 1

Raptor
Raptor

Reputation: 54222

You should give instructions to users to let them download the latest version (or you can specify a tested-OK version) of 3rd party libraries, so that you won't violate the licenses of other 3rd party libraries ( some of them won't allow you to re-distribute / bundle in other software ).

Upvotes: 1

Related Questions