First of all, thank you for your interest in contributing to dionaea!
Filing bug reports¶
Bug reports are very welcome. Please file them on the GitHub issue tracker. Good bug reports come with extensive descriptions of the error and how to reproduce it.
All patches to dionaea should be submitted in the form of pull requests to the main dionaea repository, DinoTools/dionaea. These pull requests should satisfy the following properties:
- The pull request should focus on one particular improvement to dionaea.
- Create different pull requests for unrelated features or bugfixes.
- Python code should follow PEP 8, especially in the “do what code around you does” sense.
When introducing new functionality, please remember to write documentation.
First time setup¶
- Download and install the latest version of git
- Configure git with your username and email
$ git config user.name 'Your Name' $ git config user.email 'email@example.com'
- Make sure you have a GitHub account
- Fork dionaea to your GitHub account by using the Fork button
- Clone the main repository locally
$ git clone https://github.com/DinoTools/dionaea.git $ cd dionaea
- Add your fork as a remote to push your work to. Replace <username> with your username.
$ git remote add fork https://github.com/<username>/dionaea
- Install pre-commit by using a virtualenv.
$ python3 -m venv venv_git $ source venv_git/bin/activate $ pip install pre-commit
- Install pre-commit hooks.
$ pre-commit install
Finally, pull requests must be reviewed before merging. Everyone can perform reviews; this is a very valuable way to contribute, and is highly encouraged.
The dionaea honeypot is provided under the terms of the GNU General Public License version 2 or any later (GPL-2.0+)
This documentation file provides a description of how each source file should be annotated to make its license clear and unambiguous. It doesn’t replace dionaeas license.
The license described in the LICENSE file applies to the dionaea source as a whole, though individual source files can have a different license which is required to be compatible with the GPL-2.0:
GPL-3.0+ : GNU General Public License v3.0 or later LGPL-2.0 : GNU Library General Public License v2 only LGPL-2.0+ : GNU Library General Public License v2 or later LGPL-2.1 : GNU Lesser General Public License v2.1 only LGPL-2.1+ : GNU Lesser General Public License v2.1 or later
Aside from that, individual files can be provided under one of the compatible GPL variants and alternatively under a permissive license like BSD, MIT etc.
A common way of expressing the license of a source file is to add the matching boilerplate text into the top comment of the file. Due to formatting, typos etc. these “boilerplates” are hard to validate for tools which are used in the context of license compliance.
A replacement to the boilerplate text is the use of Software Package Data Exchange (SPDX) license identifiers in each source file. SPDX license identifiers are machine parsable and precise shorthands for the license under which the content of the file is contributed. SPDX license identifiers are managed by the SPDX Workgroup at the Linux Foundation and have been agreed on by partners throughout the industry, tool vendors, and legal teams. For further information see https://spdx.org/
The dionaea honeypot requires the precise SPDX identifier in all source files. The REUSE tool from the FSFE is used to check if all required information are set. For additional information and formatting see https://reuse.software/
License identifier syntax¶
The SPDX license identifier in source files shall be added at the first possible position in a file which can contain a comment.
The SPDX license identifier is added in form of a comment. The comment style depends on the file type:
C source and header:
/** * This file is part of the dionaea honeypot * * SPDX-FileCopyrightText: 2019 Jane Doe <firstname.lastname@example.org> * * SPDX-License-Identifier: GPL-2.0-or-later */
# This file is part of the dionaea honeypot # # SPDX-FileCopyrightText: 2019 John Doe <email@example.com> # # SPDX-License-Identifier: GPL-2.0-or-later
# This file is part of the dionaea honeypot # # SPDX-FileCopyrightText: 2019 Jane Doe <firstname.lastname@example.org> # # SPDX-License-Identifier: GPL-2.0-or-later
.. This file is part of the dionaea honeypot SPDX-FileCopyrightText: 2019 John Doe <email@example.com> SPDX-License-Identifier: <SPDX License Expression>
If a specific tool cannot handle the standard comment style, then the appropriate comment mechanism which the tool accepts shall be used. For binary files or files you don’t want to change use an additional file with the same name and
The REUSE tool is used to validate if all recommendations provided bei the REUSE project of the FSFE are met. For more information about the specification have a look at https://reuse.software/ and https://spdx.dev/
Install the tool.:
$ pip install reuse
Run the linter.:
$ reuse lint
The reuse tool has been included in the pre-commit hooks to check compliance on changed files before committing them.