Contributing to Exposed

Pull Requests

Contributions are made using GitHub pull requests:

1. Fork the Exposed 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 PR title is clear and refers to an existing ticket/bug if applicable, prefixing the title with both a conventional commit and EXPOSED-{NUM}, where {NUM} refers to the YouTrack issue code. For more details about the suggested format, see commit messages.

6. 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. Complete as many sections of the PR template description as applicable.

7. If the contribution requires updates to documentation (be it updating existing content or creating new content), either do so in the same PR or file a new ticket on YouTrack. Any new public API objects should be documented with a KDoc in the same PR.

8. If the contribution makes any breaking changes, ensure that this is properly denoted in 3 ways:

   • In the PR (and commit) title using the appropriate conventional commit

   • By ticking the relevant checkbox in the PR template description

   • By adding relevant details to Breaking Changes

9. Make sure any code contributed is covered by tests and no existing tests are broken. We use Docker containers to run tests.

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

11. Finally, make sure to run the apiCheck Gradle task. If it's not successful, run the apiDump Gradle task. Further information can be found here.

Style Guides

A few things to remember:

• Your code should conform to the official Kotlin code style guide except that star imports should always be enabled. (ensure Preferences | Editor | Code Style | Kotlin, tab Imports, both Use import with '*' should be checked).

• Every new source file should have a copyright header.

• Every public API (including functions, classes, objects and so on) should be documented, every parameter, property, return types, and exceptions should be described properly.

Test functions:

• Begin each test function name with the word test.

• Employ camelCase for test function names, such as testInsertEmojisWithInvalidLength.

• Refrain from using names enclosed in backticks for test functions, because KDocs cannot reference function names that contain spaces.

• In the definition of test functions, use a block body instead of an assignment operator. For example, do write fun testMyTest() { withDb{} }, and avoid writing fun testMyTest() = withDb{}.

Commit messages

• Commit messages should be written in English.

• Their title should be prefixed according to Conventional Commits.

• 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.

• When applicable, prefix the commit message with EXPOSED-{NUM} where {NUM} refers to the YouTrack issue code.

• An example could be: fix: EXPOSED-123 Fix a specific bug

Setup