From ebe26e6c6ae77df574bfb1a48fcc6ee8ea5d99b6 Mon Sep 17 00:00:00 2001 From: Jocelyne <38375996+joc-a@users.noreply.github.com> Date: Thu, 29 Jun 2023 14:56:06 +0200 Subject: [PATCH] docs: add a point in CONTRIBUTING.md regarding API check (#1776) --- docs/CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 3edbda0e67..82e4c5f897 100644 --- 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