Kotlinmailer v2.0.0 Help

Contributing to Kotlinmailer

We're delighted that you're considering contributing to Kotlinmailer!

There are multiple ways you can contribute:

  • Code

  • Documentation

  • Community Support

  • Issues and Feature Requests

This project is proudly built and maintained by developers like you! 💖

Setup

Pull Requests

Contributions are made using Github pull requests:

  1. Fork the Kotlinmailer repository because imitation is the sincerest form of flattery.

  2. Clone your fork to your local machine.

  3. Create a new branch for your changes.

  4. Create a new PR with a request to merge to the main branch.

  5. Ensure that the description is clear and refers to an existing ticket/bug if applicable

  6. When contributing a new feature, provide motivation and use-cases describing why the feature not only provides value to you, but also why it would make sense to be part of Kotlinmailer itself.

  7. If the contribution requires updates to documentation (be it updating existing contents or creating a new one), file a new ticket on GitHub.

  8. Make sure any code contributed is covered by tests and no existing tests are broken. Run ./gradlew check, which runs the tests on all platforms available on your machine.

  9. Execute the `detekt` task in Gradle to perform code style validation.

  10. Finally, make sure to run the `apiCheck` Gradle task. If it is not successful, run the `apiDump` Gradle task. Further information can be found here.

Commit messages

  • Commit messages should be written in English

  • They should be written in present tense using imperative mood ("Fix" instead of "Fixes", "Improve" instead of "Improved"). See How to Write a Git Commit Message.

  • Add the related bug reference to a commit message (bug number after a hash character between round braces).

Documentation

There are multiple ways in which you can contribute to the Kotlinmailer docs:

  • Create an issue in GitHub.

  • Submit a pull request containing your proposed changes. Ensure that these modifications are applied directly within the docs directory.

Issues and Feature Requests

If you encounter a bug or have an idea for a new feature, submit it to us through GitHub. Before submitting an issue or feature request, search GitHub's existing issues to avoid reporting duplicates. When submitting an issue or feature request, provide as much detail as possible, including a clear and concise description of the problem or desired functionality, steps to reproduce the issue, and any relevant code snippets or error messages. Thank you for your cooperation and for helping to improve Kotlinmailer. 🫶

Last modified: 19 October 2026