From 60ab0a8fb0061759df651e05d2f68be41981927a Mon Sep 17 00:00:00 2001
From: will wade <willwade@gmail.com>
Date: Sun, 24 Aug 2025 21:22:55 +0100
Subject: [PATCH] Add UpliftAI key to test workflow

---
 .github/workflows/pythonpackage.yml |  1 +
 AGENTS.md                           | 21 +++++++++++++++++++++
 2 files changed, 22 insertions(+)
 create mode 100644 AGENTS.md

diff --git a/.github/workflows/pythonpackage.yml b/.github/workflows/pythonpackage.yml
index 1ced4f96..94faa0ae 100644
--- a/.github/workflows/pythonpackage.yml
+++ b/.github/workflows/pythonpackage.yml
@@ -95,6 +95,7 @@ jobs:
       GOOGLE_SA_FILE_B64: ${{ secrets.GOOGLE_SA_FILE_B64 }}
       PLAYHT_API_KEY: ${{ secrets.PLAYHT_API_KEY }}
       PLAYHT_USER_ID: ${{ secrets.PLAYHT_USER_ID }}
+      UPLIFTAI_KEY: ${{ secrets.UPLIFTAI_KEY }}
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
diff --git a/AGENTS.md b/AGENTS.md
new file mode 100644
index 00000000..48521eab
--- /dev/null
+++ b/AGENTS.md
@@ -0,0 +1,21 @@
+# Instructions for Contributors
+
+- Use [`uv`](https://github.com/astral-sh/uv) for dependency management.
+  Install all extras with:
+  
+  ```bash
+  uv sync --all-extras
+  ```
+
+- Run tests with:
+  
+  ```bash
+  uv run pytest -m "not synthetic and not sapi and not watson"
+  ```
+
+- The test suite requires credentials for several TTS engines. Provide
+  the necessary environment variables or a `credentials.json` file as
+  described in `tests/load_credentials.py`.
+
+- When new engines require credentials, ensure corresponding secrets are
+  added to the GitHub Actions workflow environment variables.