-
Notifications
You must be signed in to change notification settings - Fork 3
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. Please read this article if you are new to making contributions via GitHub. 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.
Given that the MailCleaner source code is licensed under the GPLv4, you can feel free to modify it to meet your needs so long as your changes are likewise made available.
However, please note that modifications can have a detrimental impact on a machine running in production. MailCleaner's Updater4MC script performs updates by pulling changes from the upstream MailCleaner repository. Changes to your local machine, or changing your origin repository to a different upstream can cause your machine to stop receiving updates.
For Enterprise Edition support you must not change any MailCleaner file without our agreement in order to maintain your warranty and support level assistance.
If you break MailCleaner code, your warranty will be void and our support time involved in restoring MailCleaner will be charged at the rate of $200 USD per hour.
Assistance via GitHub issues is provided on a best effort basis. If you show a good faith effort to provide valuable contributions to the source code, we will do our best to provide assistance in that effort. If you are working on unsupported boutique modifications, we may provide some assistance, but will generally recommend that you return to the default specifications.
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.
The Wiki for this repository could always use more work. It some guides are known to contain broken links (some even link to https://broken.link as a placeholder). Some pages contain [TODO]: <> (comments) with recommended enhancements already in place. Many could use screenshots to enhance their usability. The FAQs don't have enough Qs. Finally, all new topics on different production environments or use-cases are welcome!
If you want to contribute to a translation of MailCleaner, you can do so with Weblate.
PULL REQUESTS TRANSLATING THE INTERFACE IN THIS REPO WILL NOT BE ACCEPTED. YOU MUST USE WEBLATE
Feel free to review the Issues and see if there is a feature or bug fix that you would like to work on. Please express your intention to do so within the issue before doing any work to make sure that our team has a chance to confirm that the feature is desired or the fix is needed and so that you don't end up duplicating effort. Feel free to suggest your own features and fixes if they have not already been discussed and ruled out.
- Installation
- Overview of Admin Interface
- General Administration and Maintenance Issues
- Clustering
- Upgrading
- FAQ
Expand ▶ Pages above to view the Table of Contents for the article you are already reading, or to browse additional topics. You can also search for keywords in the Wiki.