Best/Bad practices for code sharing?

Posted by sunpech on Programmers See other posts from Programmers or by sunpech
Published on 2011-03-19T05:34:57Z Indexed on 2011/03/19 8:17 UTC
Read the original article Hit count: 800

Filed under:

best-practices

|

github

The more I explore Github, the more I like it. I really enjoy how coding is becoming more social.

I'm curious as to if there are any bad practices that programmers should avoid in sharing their code with each other. And in naming bad practices, what are the best practices for code sharing?

For example:

Is it a bad practice for a single repo to have multiple scripts/projects named 'MiscProjects'? Where this repo, as the name suggest, is a collection of miscellaneous small scripts and projects. This may resemble how a programmer organizes projects on his/her local storage, but it's possibly not optimal for code sharing?

Maybe if a good README/documentation is done, it would be better? Or as long as it's well documented, anything goes?

© Programmers or respective owner

Related posts about best-practices

Batch Best Practices and Technical Best Practices Updated

as seen on Oracle Blogs - Search for 'Oracle Blogs'
The Batch Best Practices for Oracle Utilities Application Framework based products (Doc Id: 836362.1) and Technical Best Practices for Oracle Utilities Application Framework Based Products (Doc Id: 560367.1) have been updated with updated and new advice for the various versions of the Oracle… >>> More
Partial template specialization of free functions - best practices

as seen on Stack Overflow - Search for 'Stack Overflow'
As most C++ programmers should know, partial template specialization of free functions is disallowed. For example, the following is illegal C++: template <class T, int N> T mul(const T& x) { return x * N; } template <class T> T mul<T, 0>(const T& x) { return T(0); } //… >>> More
Object Oriented PHP Best Practices

as seen on Stack Overflow - Search for 'Stack Overflow'
Say I have a class which represents a person, a variable within that class would be $name. Previously, In my scripts I would create an instance of the object then set the name by just using: $object->name = "x"; However, I was told this was not best practice? That I should have a function set_name()… >>> More
Good place to look for example Database Designs - Best practices

as seen on Stack Overflow - Search for 'Stack Overflow'
I have been given the task to design a database to store a lot of information for our company. Because the task is rather big and contains multiple modules where users should be able to do stuff, I'm worried about designing a good data model for this. I just don't want to end up with a badly designed… >>> More
Notification Email Best Practices--From Server Setup to Programming

as seen on Stack Overflow - Search for 'Stack Overflow'
All, I'm in the process now of building a SaaS tool that allows network admins to generate notification emails to the members of the end-users of our platform (among many many other things). I'm running into a bit of an "out of my expertise" wall, as I know there are a lot of variables involved… >>> More

Related posts about github

Installing GitHub for Mac - "Github cannot be opened because of a probem"

as seen on Super User - Search for 'Super User'
I'm trying to get started using Git for Mac, but I receive an error when I try to run the program. I'm new to GitHub and relatively new to Mac. First, I installed Git using the downloadable .dmg file named "git-1.7.12.3-intel-universal-snow-leopard". I ran the .pkg file contained therein and the… >>> More
update github project wiki through the github api

as seen on Stack Overflow - Search for 'Stack Overflow'
Is there a way a developer can automatically upload documentation for his project hosted on github through their API? I didn't find anything on develop.github.com related to this. It would be nice if one could just scp the files or something. >>> More
Connecting git to github on windows 7 without bash

as seen on Stack Overflow - Search for 'Stack Overflow'
I'm setting up git on my new Windows 7 machine and I'm hitting a roadblock when it comes to getting github to acknowledge my ssh key. I am doing things a little different from the standard script in that I would rather not use cygwin and prefer to use my powershell prompt. The following is what I… >>> More
Heroku and Github integration (how to structure the project)

as seen on Stack Overflow - Search for 'Stack Overflow'
I'm creating a webservice and I want to store the source on github and run the app on heroku. I haven't seen my exact scenario addressed anywhere on the 'net so far, so I'll ask it here: I want to have the following directory structure: /project .git README <-- project readme file TODO… >>> More
Best practice: git, github, lighthouse and 2 developers

as seen on Stack Overflow - Search for 'Stack Overflow'
I'm setting up a new project and plan on using git and github for sourcecontroll and hosting of repo and lighthouse for bugtracking. I've been working with git for some while now, but only been using it for more of a backup solution than collaborate coding solution. Also, I've noticed that in github… >>> More