Fixed
Details
Assignee
Bonnie RobinsonBonnie RobinsonReporter
Jeff GehlbachJeff GehlbachHB Grooming Date
Jan 18, 2022HB Backlog Status
BacklogDocs Needed
YesDoc Backlog Status
NBDoc Backlog Grooming Date
Mar 09, 2022Story Points
3Original estimate
Time tracking
No time logged4h remainingComponents
Sprint
NoneFix versions
Affects versions
Priority
Minor
Details
Details
Assignee
Bonnie Robinson
Bonnie RobinsonReporter
Jeff Gehlbach
Jeff GehlbachHB Grooming Date
Jan 18, 2022
HB Backlog Status
Backlog
Docs Needed
Yes
Doc Backlog Status
NB
Doc Backlog Grooming Date
Mar 09, 2022
Story Points
3
Original estimate
Time tracking
No time logged4h remaining
Components
Sprint
None
Fix versions
Affects versions
Priority
PagerDuty
PagerDuty
PagerDuty
Created January 14, 2022 at 4:02 PM
Updated May 12, 2023 at 1:54 PM
Resolved May 12, 2023 at 1:54 PM
raised the point that we seem to have no written guidelines for dealing with copyright dates in the headers of our source code. It's been part of institutional memory, but we need to capture it somewhere, and the official developer guide seems the right place.
Briefly, here's the deal.
Every source code file in our code bases (whether it's for OpenNMS or another project) should have a comment block at the top which includes copyright information, followed by a license portion. The copyright portion looks like this for a Java source file that is part of the main OpenNMS code base:
The two lines containing copyright dates are the focus of this issue.
The first line is specific to the file at hand. The second line applies to the code base as a larger work. One or both lines may need updating any time a developer makes changes to a file. For purposes of identification in the matrix below, I'll assign identifiers
[in brackets]
to the four years as follows:Here's an attempt at a matrix illustrating what should change in various scenarios. It assumes that the developer is updating the file in the year 2022 (Gregorian calendar).
Scenario description
Year A
Year B
Year C
Year D
Adding a new file to the OpenNMS code base
2022
(empty)
1999
2022
Updating an existing file to the OpenNMS code base, if that file was added in 2004
2004
2022
1999
2022
Adding a new file to a code base created the same year
2022
(empty)
2022
(empty)
Updating an existing file in a code base created the same year
2022
(empty)
2022
(empty)
If Year B or Year D is empty, its companion year (A or C) should not be followed by a dash.
I hope this is enough to make a start. Please tag me with any questions!