vee1e/flare-floss
1
0
Fork 0
mirror of https://github.com/vee1e/flare-floss.git synced 2026-09-01 09:49:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
flare-floss/AGENTS.md
lakshit verma e94f0a1111
docs(AGENTS): note the result cache when diffing output 
Runs serve cached documents by default, which silently mixes output from
different code revisions. Document FLOSS_CACHE_ENABLE=0 for reproducing
and diffing.
2026-08-19 17:45:08 +05:30

656 B
Raw Permalink Blame History

AGENTS.md

  • To set up the development environment, make sure that a venv is created and the pre-commit and pre-push hooks are installed, see .pre-commit-config.yaml
  • All lints, formatters and tests in .github/workflows must pass before making a PR. Enforce this strictly.
  • The floss/ folder has the main functionality, while scripts/ has auxiliary plugins and scripts. Docs are in doc/.
  • Result caching is on by default. When reproducing or diffing output across commits, disable it with FLOSS_CACHE_ENABLE=0 (or FLOSS_CACHE_DIR to point it at a scratch dir) — otherwise a run may serve a cached document written by earlier code.