KnpRadBundle icon indicating copy to clipboard operation
KnpRadBundle copied to clipboard

add copyright headers on all files

Open ghost opened this issue 11 years ago • 4 comments

I was about to copy your your data method twig extension and jquery-ujs, but neither have attribution on them.

ghost avatar Aug 09 '14 08:08 ghost

hey there! Thanks for pointing that out. I never really had interest in putting those kind of headers in each file, but it seems discusses a lot on the interwebs (http://lu.is/blog/2012/03/17/on-the-importance-of-per-file-license-information/)

By the way, are you talking about license, or @author annotations ? (or both). The license can be found in the LICENSE file, at the root of the project.

docteurklein avatar Aug 09 '14 08:08 docteurklein

sure. but if i just grab the file to put in my project (since i'm not interested in the RAD bundle atm) then there will be no attribution back to you folks who actually made it.

I'm sure that as more parts are split out.(for example moving the js code to a bower package) then you'd definitely want the license and attribution included in the files themselves since they can be pulled into projects on a file level instead of whole package (since bower's main key behaviour isn't specified)

Here's an example from symfony.

/**
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

I would suggest adding @license though. and perhaps instead of the (c) using @copyright

ghost avatar Aug 09 '14 09:08 ghost

You could do something simpler like:

/**
 * @license MIT
 * @copyright Name <somecanonical@emailaddress> year
 */

and leave it at that.

ghost avatar Aug 09 '14 09:08 ghost

one thing i did learn at that post is that it is true that there is no canonical url for the MIT license.

you could add a link to the OSI definition perhaps

ghost avatar Aug 09 '14 09:08 ghost