Skip to content

Latest commit

 

History

History
27 lines (21 loc) · 1.75 KB

README.md

File metadata and controls

27 lines (21 loc) · 1.75 KB

Coroutines integration

This directory contains modules that provide integration with various asynchronous callback- and future-based libraries. Module name below corresponds to the artifact name in Maven/Gradle.

Modules

Contributing

Follow the following simple guidelines when contributing integration with your favorite library:

  • Keep it simple and general. Ideally it should fit into a single file. If it does not fit, then consider a separate GitHub project to host this integration.
  • Follow the example of other modules. Cut-and-paste kotlinx-coroutines-guava module as a template.
  • Write tests and documentation, include top-level README.md with short overview and example.
  • Reference the new module from all the places:
  • Update links to documentation website as explained here.
  • Squash your contribution to a single commit and create pull request to develop branch.