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:
Fork the Kotlinmailer repository because imitation is the sincerest form of flattery.
Clone your fork to your local machine.
Create a new branch for your changes.
Create a new PR with a request to merge to the **master** branch.
Ensure that the description is clear and refers to an existing ticket/bug if applicable
When contributing a new feature, provide motivation and use-cases describing why the feature not only provides value to Exposed, but also why it would make sense to be part of the Exposed framework itself.
If the contribution requires updates to documentation (be it updating existing contents or creating a new one), file a new ticket on GitHub.
Make sure any code contributed is covered by tests and no existing tests are broken. We use Docker containers to run tests.
Execute the `detekt` task in Gradle to perform code style validation.
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 Exposed docs:
Create an issue in GitHub.
Submit a pull request containing your proposed changes. Ensure that these modifications are applied directly within the
docsdirectory.
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. 🫶