Skip to main content

Forums » Smalltalk » What should a github repo include?

As a CS student who just recently got a grip of the basics of programming, I have a few projects that I previously did that I want to upload and maintain on github. I won't just paste it and leave it, I plan on upgrading them with commits regularly. I used c++ in one of them and java in the other.

I want to know what you guys add to your github repos? I thought the source files and assets would be enough but is it maybe better to just dump in the whole project folder? Also, from what I've seen it's also a good habit to include license and readme texts. Is there anything else I should add?fedloan irs.gov easybib


If I got something wrong and sound stupid in any way, please excuse my ignorance and correct me. Thank you in advance.
I put everything that's not sensitive in nature into my repo. (Which is usually everything except passwords and connection strings.)
Kim Site Admin

This is the smalltalk forum, so this is fair game ;)

Just make double sure you aren't putting passwords/API keys in that repo!

Generally one does not put the dist/compiled stuff in the repo as that can be generated by whoever pulls it.

You are on: Forums » Smalltalk » What should a github repo include?

Moderators: Mina, Keke, Cass, Claine, Sanne, Dragonfire, Ilmarinen, Darth_Angelus