Ticket #70 (closed Task: fixed)

Opened 8 years ago

Last modified 7 years ago

Insert the public header in the development files

Reported by: FredCK Owned by:
Priority: Normal Milestone:
Component: General Version:
Keywords: Cc:

Description

Today, we are using a @Packager.Header block to define all files headers. That block was then processed when publishing the files publicly.

That solution was good for a closed development environment, because it was easy to make changes to the headers and reflect those changes in all files. It also guaranteed a standard format for the headers.

We are now opening the development environment, so it is the case to apply the specific copyright and license to all files. This can be easily done using a modified version of the actual "Releaser".

Another point of change in the header is the removal of the file name (redundant information) and the authors' names. We would be following a tendency in the OSS world. The names in the files don't add any value to the code, and being this a collaborative work there is no need to mark files to specific names. It is actually difficult to measure the contribution size that grants the "privilege" of having your name listed in the header. We have cases of files with hundreds of lines and names added because of changes in a couple of them. There are much better ways to be credited and so we should avoid the names in the header.

Change History

comment:1 Changed 7 years ago by fredck

  • Status changed from new to closed
  • Resolution set to fixed
Note: See TracTickets for help on using tickets.
© 2003 – 2012 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy