Contributing Guide
MailCleaner Community Edition has long been a popular Open-Source email filtering solution. While the project is guided by the MailCleaner team, we are happy to accept contributions and feedback from whoever is gracious enough to help. Find more information below on how you can help make MailCleaner better.
Note that modifications and contributions to the project are bound by the terms of the GPLv3.
Except for Translations, contribution should be made to this repository in the form of Issues and Pull Requests. Before opening either, we would ask that you search for existing and closed issues to see if they have been resolved or marked WONTFIX.
To open a Pull Request, you will need to fork the project, make changes to your fork and then use the Open Pull Request button within the GitHub WebUI to request that the changes be merged. Please ensure that you rebase your work on the latest changes from the master branch before opening the pull request.
This repository (MailCleaner-Next) represents many months of effort to update the Current version of MailCleaner which is based on Debian Jessie, to a brand new Debian Bookworm base. This effort has so far consisted of changes to almost 1 million lines of code and configuration files and updating all core packages, libraries and scripts. During that time, some things have almost definitely been updated incorrectly or broken.
We are now welcoming Alpha testers to install MailCleaner on top of a generic Debian Bookworm installation and test all of the functionality.
There are a series of open Issues for the Alpha Milestone which track progress until the Beta Milestone. We encourage our Community Edition users to wait for the Beta version before attempting to use this project in a production environment. The Alpha version is meant for testing with non-essential domains/sub-domains since we are providing no guarantees for deliverability or quality Spam filtering. We will not support this version for Enterprise Edition until all Beta Milestone goals are completed and the project can be marked as Stable.
If you want to contribute to a translation of MailCleaner, you can do so with Weblate.
PULL REQUESTS TRANSLATING THE INTERFACE WILL NOT BE ACCEPTED