Contributions

All contributions are welcome, just submit a Pull Request (PR).

It will be reviewed; any comments you receive are intended constructive. Again: all contributions are welcome. However, there are a lot of linters in the build process, so don't be discouraged if you get a few requests for improvements.

REUSE

This project uses REUSE. It requires ALL files to indicate the copyright and a license. Since this project leverages the drivers from VirtualBox, which itself is licensed under GPL-3.0, all contributions must have a license compatible with that. For GPL, in practice, that probably means it should be GPL all the way.

Adding a new file

When you add a new file, make sure it is accompanied with at least a SPDX-FileCopyrightText and a SPDX-License-Identifier tag, preferably at the top of the file. You may prefix/surround with whatever is required for the file type to make it a comment.

If a file type cannot contain such tags because the format does not allow it (e.g., plain JSON), then put the tags in a separate file with the additional extension .license, on top of the full original file name including the original extension.

Examples

• XML
• C#
• JSON (separate license file)

Initial copyright

If you started (copied) from a file with an existing copyright, copy the original notice into the first (top-most) SPDX-FileCopyrightText tag.

Next, add your own below the existing ones (if any). The preferred format is

SPDX-FileCopyrightText: <year> <name>

Use the year you instantiated the file, and then never touch it again.

Modifying an existing file

Not mandatory, but you are encouraged to add your own SPDX-FileCopyrightText right below the existing ones. It's up to you to decide whether you feel your contribution is "big enough".

Alternatively, you may add a SPDX-FileContributor tag, which feels "less heavy". Again, it's up to you.

Examples

(from another project)

• C#