Skip to content

docs: add shared onboarding and development guidance - #41

Merged
theztefan merged 1 commit into
mainfrom
feature/agent-onboarding-guardrails
Oct 27, 2026
Merged

theztefan merged 1 commit into
mainfrom
feature/agent-onboarding-guardrails

Conversation

@theztefan

Copy link
Copy Markdown
Collaborator

Summary

Makes the repository easier for AI agents and people to get started with, and sets up a shared way of working.

What's included

  • Entry points: AGENTS.md and .github/copilot-instructions.md are short pointers to the shared guidance.
  • Project instructions: contracts, guardrails, and lessons learned.
  • Python instructions: a short coding and testing style guide.
  • Architecture guide: a simple view of how a run works and where code lives.
  • Development guide: setup, checks, and a change workflow (investigate → plan → review → implement → challenge → final review), with working notes kept in a gitignored .logs/ folder.
  • CONTRIBUTING and README: made more practical, with a few out-of-date setup and validator-name details fixed.

No changes to runtime code, dependencies, or CI.

@theztefan
theztefan merged commit 672ef85 into main Oct 27, 2026
8 checks passed
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