Jump to content
  • Advertisement
Sign in to follow this  
KnolanCross

Good pratices to publish code on github?

This topic is 2056 days old which is more than the 365 day threshold we allow for new replies. Please post a new topic.

If you intended to correct an error in the post then please contact us.

Recommended Posts

Hi there guys, I have two projects that I want to share on github and I was wondering what would be a good way to organize the project. Both projects are in C.

 

In the last days I have:

- Hidden the implementations that should be hidden.

- Improved the Makefile (for instance, it adds the -g flag when compiling).

- Created a .gitignore file.

 

I am still thinking if that is enough. What do you guys expect when you clone a github repository? Should I add some samples or the tests?

 

Share this post


Link to post
Share on other sites
Advertisement

Hi there guys, I have two projects that I want to share on github and I was wondering what would be a good way to organize the project. Both projects are in C.

 

In the last days I have:

- Hidden the implementations that should be hidden.

- Improved the Makefile (for instance, it adds the -g flag when compiling).

- Created a .gitignore file.

 

I am still thinking if that is enough. What do you guys expect when you clone a github repository? Should I add some samples or the tests?

 

If you want other people to use you work, it is really useful to version and tag the code (http://semver.org) so your users have some way to understand what kind of changes they could be pulling down. Also make sure that you have a readme and that it tell me how to build and test your code, as well as what dependencies you have.

 

-Josh

Share this post


Link to post
Share on other sites
Sign in to follow this  

  • Advertisement
×

Important Information

By using GameDev.net, you agree to our community Guidelines, Terms of Use, and Privacy Policy.

GameDev.net is your game development community. Create an account for your GameDev Portfolio and participate in the largest developer community in the games industry.

Sign me up!