Merge pull request #160 from stackkit/feature/PHP-8.4

Add some contributing info

Author: marickvantuil

.env.example

@@ -6,4 +6,4 @@ CI_CLOUD_TASKS_PROJECT_ID=
 CI_CLOUD_TASKS_QUEUE=
 CI_CLOUD_TASKS_LOCATION=
 CI_CLOUD_TASKS_SERVICE_ACCOUNT_EMAIL=
-CI_SERVICE_ACCOUNT_JSON_KEY_PATH=
+CI_SERVICE_ACCOUNT_JSON_KEY_PATH=./tests/Support/gcloud-key-valid.json

.github/workflows/run-tests.yml

@@ -91,6 +91,7 @@ jobs:
         env:
           CI_SERVICE_ACCOUNT_JSON_KEY: ${{ secrets.CI_SERVICE_ACCOUNT_JSON_KEY }}
         run: |
+          touch .env
           MYSQL_PORT=3307 POSTGRES_PORT=5432 docker compose up ${{ matrix.db }} -d
       - name: Install dependencies
         run: |

README.md

@@ -202,3 +202,13 @@ Read [UPGRADING.MD](UPGRADING.md) on how to update versions.
 #### HttpRequest.url must start with 'https://'
 
 This can happen when your application runs behind a reverse proxy. To fix this, add the application domain to Laravel's [trusted proxies](https://laravel.com/docs/11.x/requests#trusting-all-proxies). You may need to add the wildcard `*` as trusted proxy.
+
+### Contributing
+
+You can use the services defined in `docker-compose.yml` to start running the package.
+
+Inside the container, run `composer install`. 
+
+Set up the environment: `cp .env.example .env`
+
+Some tests hit the Cloud Tasks API and need a project and key to be able to hit it. See the variables in `.env`