Skip to content

[extract module] add option to include GPLv3 license to new module

Torben Schiz requested to merge schiztn/dumux:fix/issue-1202 into master

What this MR does / why does DuMux need it:

Fixes #1202 (closed) . This MR adds the option to automatically add a GPLv3 license file to a new module when executing the script as discussed in issue #1202 (closed) . When choosing to add a license, licensing information is also added to the file. To my understanding, this is necessary, because in the past, without this option, it would happen regularly that new modules would be extracted and published without proper licensing, which is critical. This especially concerns code accompanying scientific papers that are published in the dumux-pub repository.

Notes for the reviewer

I put the license file in a directory in the bin directory, because I think that adding such a long text directly into the code will make the unclear and hard to read and understand. If there are better alternatives to store the license, this could be changed easily, in my opinion.

Before you request a review from someone, make sure to revise the following points:

  • does the new code follow the style guide?
  • do the test pipelines pass? (see guide on how to run pipelines for a merge request)
  • is the code you changed and/or the new code you wrote covered in the test suite? (if not, extend the existing tests or write new ones)
  • does your change affect public interfaces or behavior, or, does it introduce a new feature? If so, document the change in
  • is the list of the header includes complete? ("include what you use")
  • all files have to end with a \n character. Make sure there is no \ No newline at end of file comment in "Changes" of this MR.
Edited by Torben Schiz

Merge request reports