Skip to content

docs: add AGENTS.md with project setup, build, test, and style guidance - #62

Open
awdemos wants to merge 1 commit into
scallop-lang:masterfrom
awdemos:add-agents-md
Open

docs: add AGENTS.md with project setup, build, test, and style guidance#62
awdemos wants to merge 1 commit into
scallop-lang:masterfrom
awdemos:add-agents-md

Conversation

@awdemos

@awdemos awdemos commented Aug 15, 2026

Copy link
Copy Markdown

This PR adds a root-level AGENTS.md following the agents.md spec to help coding agents work effectively with the Scallop repository.

It covers:

  • Project overview (Rust workspace + Python bindings, nightly toolchain)
  • Setup commands (Rust nightly, Python venv, optional experiment deps)
  • Build commands for core binaries and scallopy
  • Test commands for Rust and Python, plus CI workflow references
  • Code style (rustfmt.toml, Python 2-space indentation)
  • Subproject layout (core/, etc/*)
  • Common pitfalls (stable Rust errors, torch-dependent tests, duplicate binary collisions)
  • Security and hygiene notes
  • PR instructions

No code changes are included.

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.

1 participant