mirror of
https://github.com/selfxyz/self.git
synced 2026-04-05 03:00:53 -04:00
fdb932eeba
* Add Maestro e2e testing * Run Maestro flows in parallel * Fix mobile e2e workflow * Fix e2e script flow path * prettier * fix * prettier * standardize yml files and new formatting commands * fix ndk * fix exclusions * use double quotes for yml files * feedback * fixes * fixes * fix * fix ios job * unneeded * fix workflows * fix launch workflow * fix * fix pipeline * workflow fixes * install app to emulators * better logging * save current version of test script * android works. ios wip. update locks * fix pipelines * cr feedback * fix android e2e test * Split mobile e2e workflow by platform (#842) * Replace react-native-quick-crypto with @noble/hashes (#841) * Add tests for ethers polyfills * Add crypto utils * Inline crypto polyfills into ethers util * sort and update gemfile lock * update lock * chore: incrementing ios build number for version 2.6.3 [github action] * android works. ios wip. update locks * Specify Maestro platform * Fix Android build step in e2e workflow * fix android * update ios * add concurrency * update Podfile.lock * fix android * prettier * fix * fix android pipeline * try job again * fix ios * fix android * fix ios * fix command * use android runner now that path is fixed * fix android e2e test * fix adb * add caching * fix build * speed up build * fix * test emulator options * updates * fix pipeline * fix * fix script and move on * add comment --------- Co-authored-by: Self GitHub Actions <action@github.com> * feedback * fixes * ignore for now * ignore * fix tests * fix ios simulator booting * fix ios test * shutdown after run * fix ios test * better timing * increase ios timeout * fix both flows * fix pipeline * combine command * fix ios * break up build steps for better caching * remove cache * fix ios and android test pipelines * update logic --------- Co-authored-by: Self GitHub Actions <action@github.com>
57 lines
1.6 KiB
Markdown
57 lines
1.6 KiB
Markdown
# AGENTS Instructions
|
||
|
||
This repository is a Yarn v4 monorepo with several workspaces:
|
||
|
||
- `app` – mobile app (@selfxyz/mobile-app)
|
||
- `circuits` – zk-SNARK circuits (@selfxyz/circuits)
|
||
- `common` – shared utilities (@selfxyz/common)
|
||
- `contracts` – solidity contracts (@selfxyz/contracts)
|
||
- `sdk/core` – core TypeScript SDK (@selfxyz/core)
|
||
- `sdk/qrcode` – qrcode SDK (@selfxyz/qrcode)
|
||
|
||
## Workflow
|
||
|
||
### Setup
|
||
|
||
- Run `yarn install` once before running any other commands. This installs root dependencies and sets up husky hooks.
|
||
|
||
### Commit Checks
|
||
|
||
Before committing, run the following commands:
|
||
|
||
```bash
|
||
# Lint all packages in parallel
|
||
yarn lint
|
||
|
||
# Build all workspaces except `contracts`
|
||
yarn build
|
||
|
||
# Compile Solidity contracts (may occasionally throw a Hardhat config error)
|
||
yarn workspace @selfxyz/contracts build
|
||
|
||
# Run type-checking across the repo
|
||
yarn types
|
||
```
|
||
|
||
### Tests
|
||
|
||
- Run unit tests where available:
|
||
- `yarn workspace @selfxyz/common test`
|
||
- `yarn workspace @selfxyz/circuits test` # may fail if OpenSSL algorithms are missing
|
||
- `yarn workspace @selfxyz/mobile-app test`
|
||
- Tests for `@selfxyz/contracts` are currently disabled in CI and may be skipped.
|
||
|
||
### Formatting
|
||
|
||
- Use Prettier configuration from `.prettierrc` files.
|
||
- Follow `.editorconfig` for line endings and indentation.
|
||
|
||
### Commit Guidelines
|
||
|
||
- Write short, imperative commit messages (e.g. `Fix address validation`).
|
||
- The pull request body should summarize the changes and mention test results.
|
||
|
||
## Scope
|
||
|
||
These instructions apply to the entire repository unless overridden by a nested `AGENTS.md`.
|