docs: add a point in CONTRIBUTING.md regarding API check (#1776)

JetBrains · Jun 29, 2023 · ebe26e6 · ebe26e6
1 parent 22b4002
commit ebe26e6
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -30,6 +30,8 @@ Contributions are made using Github [pull requests](https://help.github.com/en/a
 7. If the contribution requires updates to documentation (be it updating existing contents or creating new one), please
    file a new ticket on [YouTrack](https://youtrack.jetbrains.com/issues/EXPOSED).
 8. Make sure any code contributed is covered by tests and no existing tests are broken. We use Docker containers to run tests.
+9. 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](https://github.com/Kotlin/binary-compatibility-validator).
 
 #### Style Guides