76 lines
1.2 KiB
Markdown
76 lines
1.2 KiB
Markdown
# AGENTS.md
|
|
|
|
## Purpose
|
|
|
|
This document defines mandatory development rules for contributors and automated agents working on the VX Multicall Utility.
|
|
|
|
All code changes must comply with the policies below.
|
|
|
|
---
|
|
|
|
## 1. No Stubs
|
|
|
|
Stubs are not allowed.
|
|
|
|
Do **not**:
|
|
|
|
- Add placeholder functions
|
|
- Leave partially implemented logic
|
|
- Add empty modules “for later”
|
|
- Return dummy values to satisfy the compiler
|
|
|
|
All submitted code must:
|
|
|
|
- Be fully implemented
|
|
- Compile cleanly
|
|
- Function as described
|
|
- Pass relevant tests
|
|
|
|
If a feature is not ready, do not merge it.
|
|
|
|
## 2. No Dead Code
|
|
|
|
Do not introduce:
|
|
|
|
- Unused structs
|
|
- Unused enums
|
|
- Unused functions
|
|
- Unused modules
|
|
- Commented-out code
|
|
- Remove makefiles etc in freshly copied BSD sources
|
|
|
|
Remove obsolete code instead of commenting it out.
|
|
|
|
## 3. Deterministic Behavior
|
|
|
|
VX Multicall Utility requires reproducibility.
|
|
|
|
All logic must:
|
|
|
|
- Avoid non-deterministic behavior
|
|
- Avoid reliance on environment state unless explicitly defined
|
|
- Avoid hidden global state
|
|
|
|
## 4. Testing
|
|
|
|
New features must include:
|
|
|
|
- add tests for new functionality
|
|
- ensure existing tests pass
|
|
|
|
---
|
|
|
|
## Summary
|
|
|
|
VX Multicall Utility is infrastructure.
|
|
|
|
Code must be:
|
|
|
|
- Complete
|
|
- Deterministic
|
|
- Secure
|
|
- Minimal
|
|
- Explicit
|
|
|
|
No shortcuts.
|