Readme dev instructions (#98)

visual-dotnet/README.md

@@ -5,3 +5,29 @@ Sauce Labs Visual for C# expose Sauce Labs Visual Testing for your C# project wi
 ## Installation & Usage
 
 View installation and usage instructions on the [Sauce Docs website](https://docs.saucelabs.com/visual-testing/integrations/csharp/).
+
+## Building
+
+```sh
+dotnet build ./SauceLabs.Visual/SauceLabs.Visual.csproj --no-restore
+```
+
+## Linting
+
+For linting, Sauce Visual C# SDK uses [dotnet-format](https://github.com/dotnet/sdk/tree/main/documentation/format/docs) tool. It can be installed with the following command:
+
+```sh
+dotnet tool install -g dotnet-format
+```
+
+After the installation, it can be run the following command:
+
+```sh
+dotnet format '.' --verify-no-changes
+```
+
+## Running the tests
+
+```sh
+dotnet test --verbosity normal
+```

visual-java/README.md

@@ -5,3 +5,29 @@ Sauce Labs Visual for Java exposes Sauce Labs Visual Testing for your Java proje
 ## Installation & Usage
 
 View installation and usage instructions on the [Sauce Docs website](https://docs.saucelabs.com/visual-testing/integrations/java/).
+
+## Building
+
+Sauce Visual Java SDK uses [Maven](https://maven.apache.org/).
+
+`mvnw` binary, that is included in the source, can be used as a replacement if you don't have Maven.
+
+```sh
+./mvnw clean compile
+```
+
+## Linting
+
+Sauce Visual Java SDK uses [fmt](https://github.com/spotify/fmt-maven-plugin) for linting.
+
+```sh
+./mvnw com.spotify.fmt:fmt-maven-plugin:format
+```
+
+## Running the tests
+
+To run the unit tests:
+
+```sh
+./mvnw test
+```

visual-js/visual-cypress/README.md

@@ -1,8 +1,41 @@
 # Sauce Labs Visual for Cypress
 
-This package is Sauce Labs Visual integration for Cypress.<br />
+This package is Sauce Labs Visual integration for Cypress.
+
 It comes as both a plugin and commands that will be made available for your tests.
 
 ## Installation & Usage
 
 View installation and usage instructions on the [Sauce Docs website](https://docs.saucelabs.com/visual-testing/integrations/cypress/).
+
+## Building
+
+Install the dependencies
+
+```sh
+npm install
+```
+
+Build [Sauce Labs Visual client library](../visual/) since Sauce Labs Visual for Cypress depends on it
+
+```sh
+npm --prefix ../visual run build
+```
+
+Finally build Sauce Labs Visual for Cypress
+
+```sh
+npm run build
+```
+
+## Linting
+
+```sh
+npm run lint
+```
+
+## Running the tests
+
+```sh
+npm run test
+```

visual-js/visual-nightwatch/README.md

@@ -1,8 +1,35 @@
 # Sauce Labs Visual for Nightwatch
 
-This package is Sauce Labs Visual integration for Nightwatch.<br />
+This package is Sauce Labs Visual integration for Nightwatch.
+
 It comes as a service that you can add to your existing Nightwatch project.
 
 ## Installation & Usage
 
 View installation and usage instructions on the [Sauce Docs website](https://docs.saucelabs.com/visual-testing/integrations/nightwatch/).
+
+## Building
+
+Install the dependencies
+
+```sh
+npm install
+```
+
+Build [Sauce Labs Visual client library](../visual/) since Sauce Labs Visual for Nightwatch depends on it
+
+```sh
+npm --prefix ../visual run build
+```
+
+Finally build Sauce Labs Visual for Nightwatch
+
+```sh
+npm run build
+```
+
+## Linting
+
+```sh
+npm run lint
+```

visual-js/visual-storybook/CHANGELOG.md

@@ -27,3 +27,7 @@
 - Updated dependencies [ed72709]
 - Updated dependencies [0384c59]
   - @saucelabs/visual@0.4.0
+
+## 0.3.326
+
+The default clipping behaviour changed to true. This will make sure images are clipped to the boundary of components instead of capturing the whole viewport. This change will affect all non clipped baselines created with previous sdk versions. Either recreating the baselines is needed (recommended) or changing the config to false.

visual-js/visual-storybook/README.md

@@ -6,8 +6,34 @@ An extension for [Storybook's test-runner](https://github.com/storybookjs/test-r
 
 View installation and usage instructions on the [Sauce Docs website](https://docs.saucelabs.com/visual-testing/integrations/storybook/).
 
-## Changelog
+## Building
 
-### 0.3.326
+Install the dependencies
 
-The default clipping behaviour changed to true. This will make sure images are clipped to the boundary of components instead of capturing the whole viewport. This change will affect all non clipped baselines created with previous sdk versions. Either recreating the baselines is needed (recommended) or changing the config to false.
+```sh
+npm install
+```
+
+Build [Sauce Labs Visual client library](../visual/) since Sauce Labs Visual Storybook Integration depends on it
+
+```sh
+npm --prefix ../visual run build
+```
+
+Finally build Sauce Labs Visual Storybook Integration
+
+```sh
+npm run build
+```
+
+## Linting
+
+```sh
+npm run lint
+```
+
+## Running the tests
+
+```sh
+npm run test
+```

visual-js/visual-wdio/README.md

@@ -1,10 +1,41 @@
 # Sauce Labs Visual for WebdriverIO
 
+This package is Sauce Labs Visual integration for WebdriverIO.
 
-This package is Sauce Labs Visual integration for WebdriverIO.<br />
 It comes as a service that you can add to your existing WebdriverIO project.
 
 ## Installation & Usage
 
 View installation and usage instructions on the [Sauce Docs website](https://docs.saucelabs.com/visual-testing/integrations/webdriverio/).
 
+## Building
+
+Install the dependencies
+
+```sh
+npm install
+```
+
+Build [Sauce Labs Visual client library](../visual/) since Sauce Labs Visual for WebdriverIO depends on it
+
+```sh
+npm --prefix ../visual run build
+```
+
+Finally build Sauce Labs Visual for WebdriverIO
+
+```sh
+npm run build
+```
+
+## Linting
+
+```sh
+npm run lint
+```
+
+## Running the tests
+
+```sh
+npm run test
+```

visual-python/README.md

@@ -5,3 +5,23 @@ Sauce Labs Visual for Python exposes Sauce Labs Visual Testing for your Python p
 ## Installation & Usage
 
 View installation and usage instructions on the [Sauce Docs website](https://docs.saucelabs.com/visual-testing/integrations/python/).
+
+## Building
+
+`pip` is required to be able to build the Sauce Visual Python SDK. You can install the requirements for development using:
+
+```sh
+pip install -r requirements/dev.txt
+```
+
+After the requirements are installed, run the following command to build the Sauce Visual Python SDK:
+
+```sh
+python -m build
+```
+
+## Running the tests
+
+```sh
+python -m pytest
+```