xet-core / git_xet
AGENTS.md625 starsChanged 15 days agoApache-2.0View on GitHub
Git LFS custom transfer agent (git-xet) built on xet_pkg. Part of the root workspace. Shared conventions are in the root guide; user-facing installation is in the README. Run from the repository root. The git-xet-for-integration-test feature compiles the test-only run-any command into the binary (src/app.rs) and enables tests/test_ssh.rs; it is never enabled for release builds. src/test_utils/ holds only gitaskpass.sh, used by unit tests. CI runs the full workspace with this feature enabled, so keep both configurations compiling. The integration tests invoke…
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,542 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository3 other files it gives its agents.
- AGENTS.mdAGENTS.md
- hf_xet/AGENTS.mdAGENTS.md
- wasm/AGENTS.mdAGENTS.md
The file
We split this AGENTS.md into the rules it gives an agent
1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 12
Run from the repository root.
≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Agent Guide for git_xet
Git LFS custom transfer agent (git-xet) built on xet_pkg. Part of the root workspace. Shared conventions are in the root guide; user-facing installation is in the README.
Setup
gitandgit-lfsmust be onPATH, and rungit lfs installonce. Many unit tests create real repositories withTestRepo/TempHomefromgit_extension_common'stest-utilsfeature, under a temporaryHOMEso your global Git config is untouched.- The integration tests in
tests/test_ssh.rsstart a local SSH server withstart_local_ssh_serverfromgit_extension_common'stest-utilsfeature; no external SSH service is needed.
Build and test
Run from the repository root.
| Command | Purpose |
cargo test --package git_xet | Unit tests |
cargo test --package git_xet --features git-xet-for-integration-test | Unit tests plus SSH and process-invocation integration tests |
cargo clippy -r --verbose -- -D warnings | Lint (with the root workspace) |
cargo build --package git_xet --release | Build the git-xet binary |
The git-xet-for-integration-test feature compiles the test-only run-any command into the binary (src/app.rs) and enables tests/test_ssh.rs; it is never enabled for release builds. src/test_utils/ holds only gitaskpass.sh, used by unit tests. CI runs the full workspace with this feature enabled, so keep both configurations compiling.
The integration tests invoke the freshly built git-xet binary through git xet run-any, so they run as a child of a real git process, the same way git-lfs launches the agent. Their main purpose is Windows behavior (Git for Windows adds MinGW/MSYS utilities such as ssh and sh to the child PATH), so check the Windows CI job when touching process spawning or SSH handling, including the shared code in git_extension_common. Tests that mutate environment variables use #[serial(...)] from serial_test; follow that pattern for new ones.
git_xet is excluded from cargo bench; do not add benchmarks here.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.