Jump to: navigation, search

Source file headers

124 bytes added, 01:37, 11 June 2020
no edit summary
The Gramps project requires that all source code files stored in the official project repository include the following header at the top of the file:
<codepre> # # Gramps - a GTK+/GNOME based genealogy program # # Copyright (C) 20xx-20xy 20xx Contributor1 Name # Copyright (C) 20xx Contributor2 Name # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 59 Temple Place51 Franklin Street, Suite 330Fifth Floor, Boston, MA 0211102110-1307 1301 USA #</codepre>
== File header procedure ==
The following procedures regarding source file headers shall be followed by all contributors whose changes are committed to the official project source repository:
* When a new source file is created, the header shall be pre-pended prepended to the file before the file is committed to the source repository.
* The original file author shall include his/her name in the copyright statement along with the year the file was created.
* Additional contributors shall add their names and respective years of contribution in the copyright statement if they make changes to the file in the source repository.
== Copyright statement examples ==
Single author, all contributions in the same year:
<codepre> # Copyright (C) 2005 2015 John Doe</codepre>
Single author, contributions in a range of years:
<codepre> # Copyright (C) 20052014-2009 2015 John Doe</codepre>
Single author, contributions in sparse years:
<codepre> # Copyright (C) 2005, 2007-2008 2013 John Doe</codepre>
Multiple authors, contributions in various years:
<codepre> # Copyright (C) 2005, 2007-2008 2013 John Doe <[email protected]> # Copyright (C) 2008 2009 Jane Smith # Copyright (C) 2006-2007 Ed Johnson <[email protected]></codepre==See also==*[[Howto: Contribute to Gramps]] [[Category:Plugins]][[Category:Developers/Tutorials]][[Category:Developers/General]][[Category:Reports|H]]

Navigation menu