From 8d17618090cded5685df1b5a80cc4c84ba240583 Mon Sep 17 00:00:00 2001 From: Sander Declerck Date: Fri, 5 Sep 2025 12:55:31 +0200 Subject: [PATCH] Document the workspace setup in CONTRIBUTING --- .github/CONTRIBUTING | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/.github/CONTRIBUTING b/.github/CONTRIBUTING index 1fd93f8..5322818 100644 --- a/.github/CONTRIBUTING +++ b/.github/CONTRIBUTING @@ -21,15 +21,20 @@ Report issues on our [GitHub Issues page](https://github.com/AikidoSec/safe-chai ## Development +**Workspace Structure:** +- `packages/safe-chain/` - Main CLI package +- `test/e2e/` - End-to-end tests + **Setup:** ```bash -npm install +npm install # Installs dependencies for all workspaces ``` **Commands:** -- `npm test` - Run tests -- `npm run test:watch` - Watch mode +- `npm test` - Run unit tests +- `npm run test:e2e` - Run end-to-end tests - `npm run lint` - Check code style +- `npm run test --workspace=packages/safe-chain` - Test specific workspace **Requirements:** - Node.js 18+