Skip to content

GitLab

Last edited by Arne Keller
Page history

General guideline for all file types

General file guidelines

In the other sections of this Wiki, a number of guidelines for frequent file types are given. These are based on a few general principles:

  • Header: Any file in a human readable file format should normally have a header section, which minimally states: The file is part of VIRTUAL, the license under which the file is released, and the author(s) of the files. Details and possible additions are given in the section Headers.
  • License: Any file must be subject to an open access license. There are different license types possible( see Licenses section). Restrictions or alterations to these are eventually possible, but have to be discussed with the platform admins. In any case, it must be clearly stated (normally in the header, alternatively/where no header is possible in a project README) which license holds and where its text can be found.
  • Copyright: The copyright holders of the files must be specified (at least if the VIRTUAL consortium does not own the copyright directly).
  • Documentation: Any published model, tool or code must be documented in a way that external users can readily apply them. For more details, see the sub-point "Documentation" in the content guidelines!