Skip to content

chore: add scripts and configs layout - #15

Merged
snimu merged 3 commits into
mainfrom
chore/add-scripts-configs-guidance
Aug 28, 2026
Merged

snimu merged 3 commits into
mainfrom
chore/add-scripts-configs-guidance

Conversation

@snimu

@snimu snimu commented Aug 28, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • add configs/ for reusable environment test and evaluation settings
  • document scripts/ as the home for sandbox image helpers and other supporting development code
  • define matching configs/<env-name>/ and scripts/<env-name>/ conventions in AGENTS.md
  • keep the new layout prose unwrapped
  • align Markdown validation with the current research-environments convention
  • extend Markdown pre-commit coverage to both directories

Validation

  • uv run pytest -n auto tests -m "not integration" -v
  • uv run ruff check .
  • uv run ruff format --check .
  • uv run pre-commit run --all-files
  • uvx mdformat --check --wrap no README.md configs/README.md scripts/README.md

Note

Add scripts/ and configs/ directory layout with lint and doc updates

  • Introduces scripts/<env-name>/ for environment-specific support code and configs/<env-name>/ for reusable test/eval configurations, documented in new scripts/README.md and configs/README.md
  • Updates AGENTS.md and README.md with guidance on where sandbox images, build helpers, and configs belong; clarifies that synthetic data generation stays under generators/
  • Expands the markdownlint pre-commit hook in .pre-commit-config.yaml to lint Markdown under configs/ and scripts/, and adjusts .markdownlint-cli2.yaml to allow inline <h3> and disable MD029/MD036/MD041 in README.md

Macroscope summarized 710beab.

@snimu
snimu marked this pull request as ready for review August 28, 2026 20:51
@snimu
snimu requested a review from a team as a code owner August 28, 2026 20:51
@snimu
snimu marked this pull request as draft August 28, 2026 20:52
@snimu
snimu marked this pull request as ready for review August 28, 2026 21:09
@snimu
snimu marked this pull request as draft August 28, 2026 21:14
@snimu
snimu marked this pull request as ready for review August 28, 2026 21:15
@snimu
snimu merged commit cfaf51b into main Aug 28, 2026
9 checks passed
@snimu
snimu deleted the chore/add-scripts-configs-guidance branch August 28, 2026 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants