feat(MINOR): add contributing guideline & sync (#27)

Author: Orkun

contributing.md

@@ -0,0 +1,26 @@
+# Contributing to Fingerprint Pro Server API SDK
+
+## Structure
+
+Most files in the project are autogenerated by [swagger-codegen](https://swagger.io/tools/swagger-codegen/) for php.
+
+- [template](./template) - folder contains redefined templates of `swagger-codegen`. Original templates you can find in [swagger-codegen repo](https://github.com/swagger-api/swagger-codegen/tree/751e59df060b1c3ecf54921e104f2086dfa9f820/modules/swagger-codegen/src/main/resources/php).
+- [docs](./docs) - generated documentation for models and [API Client](./docs/Api/FingerprintApi.md).
+- [src](./src) - API Client code is generated automatically.
+
+## Code generation
+
+You need `swagger-codegen` to run code generation. There are many ways described in the [readme](https://github.com/swagger-api/swagger-codegen).
+In the project we use local jar file `bin/swagger-codegen-cli.jar`.
+
+You can just run `sh ./scripts/generate.sh` script and it will do all the work.
+
+To download fresh OpenAPI schema run `sh ./scripts/sync.sh`
+
+### Configuration
+
+Project configuration is described in `config.json` file. To read about available parameters run the command below:
+
+```shell
+java -jar ./bin/swagger-codegen-cli.jar config-help -l php
+```

scripts/sync.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+curl -o ./res/fingerprint-server-api.yaml https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/schemes/fingerprint-server-api.yaml
+
+examplesList=(
+  'visits_limit_500.json'
+  'get_event.json'
+)
+
+for example in ${examplesList[*]}; do
+  curl -o ./test/mocks/"$example" https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/examples/"$example"
+done
+
+./scripts/generate.sh