Document the workspace setup in CONTRIBUTING

This commit is contained in:
Sander Declerck 2025-09-05 12:55:31 +02:00
parent 75deed9370
commit 8d17618090
No known key found for this signature in database

11
.github/CONTRIBUTING vendored
View file

@ -21,15 +21,20 @@ Report issues on our [GitHub Issues page](https://github.com/AikidoSec/safe-chai
## Development ## Development
**Workspace Structure:**
- `packages/safe-chain/` - Main CLI package
- `test/e2e/` - End-to-end tests
**Setup:** **Setup:**
```bash ```bash
npm install npm install # Installs dependencies for all workspaces
``` ```
**Commands:** **Commands:**
- `npm test` - Run tests - `npm test` - Run unit tests
- `npm run test:watch` - Watch mode - `npm run test:e2e` - Run end-to-end tests
- `npm run lint` - Check code style - `npm run lint` - Check code style
- `npm run test --workspace=packages/safe-chain` - Test specific workspace
**Requirements:** **Requirements:**
- Node.js 18+ - Node.js 18+