Refactoring #1357

Feature #1290: === Core: framework ===

to discuss: authorship and file headers

Added by wuttke about 4 years ago. Updated about 4 years ago.

Status:ResolvedStart date:29 Feb 2016
Priority:NormalDue date:
Assignee:-% Done:

0%

Category:-
Target version:-

Description

How shall our file headers evolve over the years?
Currently we have:

// ****************************************************************** //
//
// BornAgain: simulate and fit scattering at grazing incidence
//
//! @file coregui/Models/SphericalDetectorItem.cpp
//! @brief Implements class SphericalDetectorItem
//!
//! @homepage http://www.bornagainproject.org
//! @license GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum J├╝lich GmbH 2015
//! @authors Scientific Computing Group at MLZ Garching
//! @authors C. Durniak, M. Ganeva, G. Pospelov, W. Van Herck, J. Wuttke
//
// ****************************************************************** //

Possibility 1:
Once per year, update all file headers: increment the year,
and possibly the author list (which will become longer and
longer over the years).

Possibility 2:
Leave file headers frozen as they are.
However, when creating new files, use fresh header with current
year and current author list.

History

#1 Updated by wuttke about 4 years ago

  • Parent task set to #1290

Wait for discussions at ILL/PSI.

#2 Updated by wuttke about 4 years ago

  • Status changed from New to Resolved

Decision taken: possibility 2.

Leave file headers frozen as they are.
When substantially modifying a file, update creation time range (from-to), and increment author list.
When creating new files, use fresh header with current year and current author list.

Rationale:
  • Only this solution allows for reuse of code fragments from other projects
  • In the long run, this solution reveals more details about the project's history
  • Has been agreed with ILL for project NSXTool, and is suitable for other projects as well

Also available in: Atom PDF