I'm about to push my first project to GitHub (a mini toy lisp interpreter written in C).
I've noticed that the vast majority of open source projects include their license in every source file (at the top). Is that a necessity for open source?
Software Engineering Stack Exchange is a question and answer site for professionals, academics, and students working within the systems development life cycle. It only takes a minute to sign up.Sign up to join this community
This is an old question, but for anyone else looking for the answer, most licenses don't require the license to be included inside each source file, as long as the license is included with the source code. Often this is done by use of a
LICENSE.txt file included in the same repo, folder, or directory as the code.
Below is a rundown of some common open source licenses and their requirements regarding inclusion in source files.
One of the (many) reasons Apache released v2.0 of the Apache License was:
... to allow the license to be included by reference instead of listed in every file... (source)
The MIT License only requires that the license text:
be included in all copies or substantial portions of the Software.
For the GPL, LGPL, or AGPL license, the Free Software Foundation,
which runs GNU.org, does want a notice included within each file (as well as in an accompanying
COPYING file containing the full license text, or
COPYING LESSER if using the LGPL).
Here's how they say to include the license in your source files:
This involves adding two elements to each source file of your program: a copyright notice (such as “Copyright 1999 Terry Jones”), and a statement of copying permission, saying that the program is distributed under the terms of the GNU General Public License (or the Lesser GPL, or the Affero GPL).
Note that I am not a lawyer and this answer does not even remotely constitute any sort of legal advice.
It is not necessary (depending on the exact license though) but a good practice for both commercial and open source software. Moreover, with the emergence of a proper standard called SPDX (Software Package Data Exchange®), it becomes easier for both developers and lawyers to audit the code for copyrights and licenses.
And example of such header for C/C++ language would look like:
// SPDX-FileCopyrightText: 2019 Jane Doe <[email protected]> // SPDX-License-Identifier: GPL-3.0-or-later
Moreover, there is an initiative called REUSE Software that provides good guidelines for any kind of project on how to add, manage, and audit copyright and license information. One of the results of this initiative is the automated Python tool to check the compliance for the latest REUSE and SPDX recommendations. It is called
reuse and provides a linter feature, see more at their documentation page. To learn more about compliance and steps required, see the full REUSE tutorial.