Stellar Agent Guard

Appearance

Organization Contributing Guide ​

This guide applies across all repositories in the stellar-agent-guard organization:

  • stellar-agent-guard-contracts
  • stellar-agent-guard-sdk
  • stellar-agent-guard-dashboard

📝 Commit Convention ​

Commits follow Conventional Commits:

<type>(<scope>): <imperative summary>

Allowed types: feat, fix, docs, chore, ci, test.

The One File Per Commit Rule ​

Every commit and push across all repositories must touch exactly one file:

  • Never bundle a source change with its test file.
  • Never bundle a doc update with the code file it describes.
  • Maintain atomic commit reviewability and clean revert boundaries.

Verify before committing:

bash
git diff --cached --name-only

Output must show exactly 1 path.

🌿 Branching & Review Policy ​

  • Main Protection: main is protected by mandatory status check ci.
  • Solo-Maintainer Policy: PRs require green CI checks. Main-protection ruleset bypass is documented and used by the maintainer to merge without an unsatisfiable second review requirement.
  • Branch Cleanup: Remote and local branches are deleted immediately after PR merge. git branch -a must show main only.

🧪 Pre-Push Testing Checklist ​

Contracts (stellar-agent-guard-contracts) ​

bash
cargo test
cargo clippy --all-targets -- -D warnings
cargo fmt --check

SDK (stellar-agent-guard-sdk) ​

bash
npm run typecheck
npm run lint
npm test

Dashboard (stellar-agent-guard-dashboard) ​

bash
npm run typecheck
npm run lint
npm test
npm run build