The_Great_Archive/maltrail
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
master
maltrail/.github/CONTRIBUTING.md
Miroslav Stampar 761a38cd7c Initial commit (fresh repo)
2026-01-03 00:10:15 +01:00

4.6 KiB
Raw Permalink Blame History

Contributing to Maltrail

Reporting bugs

Bug reports are welcome! Please report all bugs on the issue tracker.

If you have a security related report, take a time to read Reporting Maltrail Security Vulnerability policy.

Guidelines

  • Before you submit a bug report, search both open and closed issues to make sure the issue has not come up before.
  • Make sure you can reproduce the bug with the latest release version of Maltrail.
  • Your report should give detailed instructions on how to reproduce the problem. If Maltrail raises an unhandled exception, the entire traceback is needed. Details of the unexpected behaviour are welcome too. A small test case is ideal to have.
  • If you are making an enhancement request (RFE, feature request), lay out the rationale for the feature you are requesting. Describe why would proposed feature be useful.

Submitting code changes

All code contributions are greatly appreciated. First off, clone the Git repository, read the User's manual and the Wiki pages carefully, go through the code yourself and drop us an email if you are having a hard time grasping its structure and meaning.

Our preferred method of patch submission is via a Git pull request.

Many people have contributed in different ways to the Maltrail development. See also the Maltrail's "Thank you" list.

Guidelines

In order to maintain consistency and readability throughout the code, we ask that you adhere to the following instructions:

  • Each patch should make one logical change.
  • Avoid tabbing, use four blank spaces instead.
  • Before you put time into a non-trivial patch, it is worth discussing it privately by email.
  • Do not change style on numerous files in one single pull request, we can discuss about those before doing any major restyling, but be sure that personal preferences not having a strong support in PEP 8 will likely to be rejected.
  • Make changes on less than five files per single pull request - there is rarely a good reason to have more than five files changed on one pull request, as this dramatically increases the review time required to land (commit) any of those pull requests.
  • Style that is too different from main branch will be ''adapted'' by the developers side.
  • Do not touch anything inside thirdparty/ folder.

Maltrail trails contribution

All contributions to static trails (adding new Maltrail detections, fixing false positives, updating whitelist, etc) are greatly appreciated. Before you submit a contribution to Maltrail detection trails database, take a time to read respective auxiliary articles in Maltrail's Wiki:

Licensing

By submitting code contributions to the Maltrail developers or via Git pull request, checking them into the Maltrail source code repository, it is understood (unless you specify otherwise) that you are offering the Maltrail copyright holders the unlimited, non-exclusive right to reuse, modify, and relicense the code. This is important because the inability to relicense code has caused devastating problems for other software projects. If you wish to specify special license conditions of your contributions, just say so when you send them.