👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to mailserver and its packages. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
I don't want to read this whole thing, I just have a question!!!
What should I know before I get started?
Please file an issue labelled
help wantedto ask a question. There is no message board at this point.
Mailserver is an open source project — it's made up of 5 repositories. When you initially consider contributing to Mailserver, you might be unsure about which of those 5 repositories implements the functionality you want to change or report a bug for. This section should help you with that.
Mailserver is intentionally modular. Its main mail-related functions are separated which come from individual packages. Here's a list:
- docker-mailserver - Provides help, guidance and examples how to orchestrate the Docker images
- docker-mailserver-postfix - Implements the core mailing functionality to send and receive messages.
- docker-mailserver-opendkim - Implements the DKIM signing functionality.
- docker-mailserver-postfixadmin - Provides administration function for domains and mailboxes
- docker-mailserver-amavis - Provides mail scanners to detect viruses and spam
- docker-mailserver-roundcube - A webmail interface that lets you pick-up, read, manage and send e-mails
When a significant decision is taken in how to maintain the project and what can or cannot be supported, it will be documented it in the technicalguru/docker-mailserver repository. If you have a question around how to do things, check to see if it is documented there. If it is not documented there, please open a new issue there.
This section guides you through submitting a bug report for Mailserver. Following these guidelines helps to understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.
Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
- Determine which repository the problem should be reported in.
- Perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.
Bugs are tracked as GitHub issues. After you've determined which repository your bug is related to, create an issue on that repository and provide the following information.
Explain the problem and include additional details to help reproducing the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you started the containers, e.g. which command exactly you used in the terminal, or how you started it otherwise. When listing steps, don't just say what you did, but explain how you did it. For example, if you sent out an e-mail, explain how you submitted it to the mailserver, what client you have used and how your client was configured to use the interface.
- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
- Include log files and screen shots which show you following the described steps and clearly demonstrate the problem.
- If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.
Provide more context by answering these questions:
- Can you reproduce the problem?
- Did the problem start happening recently (e.g. after updating to a new version of Mailserver) or was this always a problem?
- If the problem started happening recently, can you reproduce the problem in an older version of Mailserver? What's the most recent version in which the problem doesn't happen? You can download older versions of Mailserver from the releases pages of the individual packages.
- Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
Include details about your configuration and environment:
- Which versions of Mailserver components are you using? You can get the exact versions by checking out the Docker image tags, e.g. running
docker ps --format "{{.ID}}: {{.Image}}"|grep mailserverin your terminal, or - for Kubernetes -kubectl get pods --all-namespaces -o yaml|grep "image: technicalguru/mailserver". - Are you running Mailserver in a Kubernetes cluster? If so, which Kubernetes version are you using and which Ingress controller and network plugin are installed?
- Are you using custom configuration files? If so, provide the contents of those files, preferably in a code block or with a link to a gist.
Attention! Do not include any password or secret in your issue description or its attachments. Blank them out as
******or replace them bymypasswordinstead.
This section guides you through submitting an enhancement suggestion for Mailserver, including completely new features and minor improvements to existing functionality. Following these guidelines helps to understand your suggestion 📝 and find related suggestions 🔎.
Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible.
- Determine which repository the enhancement should be suggested in.
- Perform a cursory search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
Enhancement suggestions are tracked as GitHub issues. After you've determined which repository your enhancement suggestion is related to, create an issue on that repository and provide the following information:
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Explain why this enhancement would be useful to most Mailserver users and isn't something that can or should be implemented as custom configuration.
- List some other mailserver implementation and configurations where this enhancement exists.
- Specify which version of Mailserver you're using. You can get the exact versions by checking out the Docker image tags, e.g. running
docker ps --format "{{.ID}}: {{.Image}}"|grep mailserverin your terminal, or - for Kubernetes -kubectl get pods --all-namespaces -o yaml|grep "image: technicalguru/mailserver". - Are you running Mailserver in a Kubernetes cluster? If so, which Kubernetes version are you using and which Ingress controller and network plugin are installed?
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- When only changing documentation, include
[ci skip]in the commit title - Consider starting the commit message with an applicable emoji:
- 🎨
:art:when improving the format/structure of the code - 🐎
:racehorse:when improving performance - 🚱
:non-potable_water:when plugging memory leaks - 📝
:memo:when writing docs - 🐧
:penguin:when fixing something on Linux - 🍎
:apple:when fixing something on macOS - 🏁
:checkered_flag:when fixing something on Windows - 🐛
:bug:when fixing a bug - 🔥
:fire:when removing code or files - 💚
:green_heart:when fixing the CI build - ✅
:white_check_mark:when adding tests - 🔒
:lock:when dealing with security - ⬆️
:arrow_up:when upgrading dependencies - ⬇️
:arrow_down:when downgrading dependencies - 👕
:shirt:when removing linter warnings
- 🎨
Use the Markdown syntax for documentation files.
This section lists the labels we use to help us track and manage issues and pull requests. Labels are used across all Mailserver repositories.
GitHub search makes it easy to use labels for finding groups of issues or pull requests you're interested in. For example, you might be interested in open issues across Mailserver which are labeled as bugs, but still need to be reliably reproduced or perhaps open pull requests in technicalguru/docker-mailserver-postfix which haven't been reviewed yet. To help you find issues and pull requests, each label is listed with search links for finding open items with that label across all Mailserver repositories. We encourage you to read about other search filters which will help you write more focused queries.
The labels are loosely grouped by their purpose, but it's not required that every issue have a label from every group or that an issue can't have more than one label from the same group.
Please open an issue on technicalguru/docker-mailserver if you have suggestions for new labels, and if you notice some labels are missing on some repositories, then please open an issue on that repository.
| Label name | Search 🔎 | Description |
|---|---|---|
enhancement |
search | Feature requests. |
bug |
search | Confirmed bugs or reports that are very likely to be bugs. |
question |
search | Questions more than bug reports or feature requests (e.g. how do I do X). |
feedback |
search | General feedback more than bug reports or feature requests. |
help-wanted |
search | The author or maintainer would appreciate help from the community in resolving these issues. |
beginner |
search | Less complex issues which would be good first issues to work on for users who want to contribute to Mailserver. |
more-information-needed |
search | More information needs to be collected about these problems or feature requests (e.g. steps to reproduce). |
needs-reproduction |
search | Likely bugs, but haven't been reliably reproduced. |
blocked |
search | Issues blocked on other issues. |
duplicate |
search | Issues which are duplicates of other issues, i.e. they have been reported before. |
wontfix |
search | The maintainer has decided not to fix these issues for now, either because they're working as intended or for some other reason. |
invalid |
search | Issues which aren't valid (e.g. user errors). |
package-idea |
search | Feature request which might be good candidates for new packages, instead of extending Mailserver packages. |
wrong-repo |
search | Issues reported on the wrong repository. |
| Label name | Search 🔎 | Description |
|---|---|---|
documentation |
search | Related to any type of documentation. |
performance |
search | Related to performance. |
security |
search | Related to security. |
ui |
search | Related to visual design. |
crash |
search | Reports of Docker image completely crashing. |
network |
search | Related to network problems or working with remote files (e.g. on network drives). |
git |
search | Related to Git functionality (e.g. problems with gitignore files or with showing the correct file status). |
| Label name | Search 🔎 | Description |
|---|---|---|
work-in-progress |
search | Pull requests which are still being worked on, more changes will follow. |
needs-review |
search | Pull requests which need code review, and approval from maintainers. |
under-review |
search | Pull requests being reviewed by maintainers. |
requires-changes |
search | Pull requests which need to be updated based on review comments and then reviewed again. |
needs-testing |
search | Pull requests which need manual testing. |