Added comments and license headers

[bubbapizza]

GUYZ WHERE DID MY WRITE PERMISSIONS TO THE HACKF REPO GO????

P.S. I LOVE TYPING IN CAPS

[Taar]

The license info isn't needed for each file. There is a LICENSE file in the root directory that contains all of that information,

What are your goals of these comments? Are you looking for clarification?

[bubbapizza]

I was just using the GNU licensing standards. It says you should put the license header in every file: http://www.gnu.org/licenses/gpl-howto.html According to that page, it it shows a sample header and then says:

This statement should go near the beginning of every source file, close to the copyright notices. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If you read the license header, at the bottom, it says:

You should have received a copy of the GNU General Public License along with Foobar. If not, see http://www.gnu.org/licenses/. <-------- This means the license file you included

And yes, the comments were for clarification. Jeff explained things so I will clean them up.

[jeffszusz]

I believe the license headers and license file are an either/or choice you can make on a project-by-project basis. Most projects I've bothered to read source for just have the license file, at least on github.

[bubbapizza]

Hey no hurt feelings. I just normally just go by the gold standard: Richard Stallman invented the license and he says put a header so I put a header.

[jeffszusz]

It seems we're both half-right. As per http://www.gnu.org/copyleft/gpl.html, "each file should have at least the “copyright” line and a pointer to where the full notice is found." Soooo...

# This file is part of hackf/rpi_door
#
# (c) 2013 Windsor Hackforge
#
# For full copyright and license information, please view the LICENSE
# file that was distributed with this source code.

Change your headers to that ^^^, clean up the comments so they only explain things that aren't obvious, and we're like to lend you our thumbs, good sir! :beer: You'll want to pull the latest and merge it with your changes before making additional updates, too, since some other changes have taken place to README and LICENSE etc.

If you're interested in converting some of your comments and my explanations to standard python docstrings, http://www.python.org/dev/peps/pep-0257/ is the guide!

The reason we include just one LICENSE file, and don't mention the license being followed in the header of every file, is that subsequent versions of this repository can be distributed under newer versions of the GPL or other open licenses. We only want to update a single file if that ever happens, instead of having to update every file.

We all just want the best possible finished product, so reviewers are going to be picky sometimes, but not personal - just like when our peers review our PRs at our day jobs.

[jeffszusz]

@bubbapizza please also feel free to give a thumbs up to https://github.com/hackf/rpi_door/pull/3

Randy decided to write the initial version of this code as a volunteer of Hackforge (as a 'work for hire') and therefore the copyright belongs to the Hackforge and not to him.

[jeffszusz]

Also, regarding "GUYZ WHERE DID MY WRITE PERMISSIONS TO THE HACKF REPO GO????"

You still have permissions to create a repo etc, github just doesn't let us automatically push from a fork to the upstream without a PR.

Once a repository exists with initial code up, we shouldn't ever push anything directly, anyway. Even Randy will be forking and submitting PR's for community approval as we go forward with this project. We don't have a huge contributor base yet but laying the groundwork for some official-ish practices is important early on ;)

[bubbapizza]

Hey, thanks for the input Jeff, I'll see if I can clean it up in the next couple days. Also I have some really cool ideas about creating a hardware widget toolkit that kind of takes the idea of software widgets (buttons, drop-down boxes, radio buttons, text fields, etc) but applying it to hardware. It's a long story so I'll have to run it by you guys the next time we meet in person.

[Taar]

Going to close this since we've added a license file and license headers to the files in question.