From 1e906510d53f7f647266f4fc80acd49eea29cfd2 Mon Sep 17 00:00:00 2001
From: Simon Popugaev <senia.psm@gmail.com>
Date: Mon, 5 Feb 2024 06:22:14 +0300
Subject: [PATCH] integration tests in CONTRIBUTING.md

---
 CONTRIBUTING.md | 21 +++++++++++++++++++++
 README.md       |  5 ++++-
 2 files changed, 25 insertions(+), 1 deletion(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..b88cbb4
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,21 @@
+## Running integration tests
+
+Integration tests are stored in `tests` directory.
+
+You can run all tests with
+```shell
+./scripts/it.sh
+```
+
+To run individual tests you should first build all executables with `./scripts/build-all.sh` and then run tests by name:
+```shell
+GOLEM_DOCKER_SERVICES=true GOLEM_TEST_TEMPLATES="./test-templates" cargo test worker_new_instance
+```
+
+With `QUIET=true` you can hide services output:
+```shell
+QUIET=true GOLEM_DOCKER_SERVICES=true GOLEM_TEST_TEMPLATES="./test-templates"  cargo test
+```
+
+This way tests will use configured versions of golem docker images.
+To run tests against the latest binaries without docker - see [`golem-services` CONTRIBUTING.md](https://github.com/golemcloud/golem-services/blob/main/CONTRIBUTING.md)
diff --git a/README.md b/README.md
index c86efcb..cbc38b7 100644
--- a/README.md
+++ b/README.md
@@ -24,4 +24,7 @@ cargo install golem-cli
 ```
 
 ## More information
-Please check the [Golem Cloud developer documentation portal](https://www.golem.cloud/learn) to learn more about how to get started with *Golem Cloud*!
\ No newline at end of file
+Please check the [Golem Cloud developer documentation portal](https://www.golem.cloud/learn) to learn more about how to get started with *Golem Cloud*!
+
+## Contributing
+Find details [here](CONTRIBUTING.md)
\ No newline at end of file