chore: docs
This commit is contained in:
1 parent
25434b35b9
commit
1ed31f2a49
1 file changed
+21
@@ -59,3 +59,24 @@ lineage/catalog refresh and do not affect the deploy.
|
||||
`npm run 4gl && sasjs test -t 4gl` from `sas/` — see `.agents/docs/testing.md`.
|
||||
- `sas/sasjsbuild/` is generated build output — never hand-edit it; edit sources under
|
||||
`sas/sasjs/` only.
|
||||
|
||||
## Temp and scratch files stay out of the repo
|
||||
|
||||
Transient artifacts from manual test runs against sasjs-server — captured `_webout` JSON
|
||||
responses (e.g. `*_out.json`), request/response logs (e.g. `*.log`), and iteration snapshots
|
||||
(`vd_out2.json`, `stage_check2.json`, etc.) — must not be left in the working tree. They
|
||||
clutter `git status`, are never referenced by source or tests, and easily leak local
|
||||
filesystem paths (the sasjs-server session dir, `/home/.../sasjs_root/sessions/.../`) into
|
||||
committed history.
|
||||
|
||||
Write them to a gitignored tmp location instead. The repo already provides two:
|
||||
|
||||
- `tmp/` (gitignored at repo root) — general scratch space.
|
||||
- `sas/tmp/` (gitignored via the root `tmp/` rule) — for SAS-side artifacts.
|
||||
|
||||
If a helper script dumps captured output for comparison during a debug session, point it at
|
||||
`tmp/` (or `sas/tmp/` for SAS-local paths) rather than alongside the tracked mocks in
|
||||
`sas/mocks/`. The tracked mock fixtures live under `sas/mocks/sas9/` and
|
||||
`sas/mocks/sasjs/services/`; loose `*_out.json` / `*.log` files at the `sas/mocks/` root are
|
||||
not mocks, they are leftover captures — remove them with `git clean -fd sas/mocks/` or
|
||||
write to `tmp/` in the first place.
|
||||
Reference in new issue
Block a user