Contributing
A good contribution makes the architecture easier to inspect, understand or adapt.
Useful places to start
- Report a broken link or unclear explanation with the exact file and section.
- Suggest a better folder or boot convention with a small fictional example and its tradeoff.
- Add a reproducible case for the sample pointer generator or read-only architecture checker.
- Explain a host-specific adaptation and clearly separate what you configured from what you tested.
Use invented data. Remove private paths, identities, records, account settings and credentials from examples, logs and screenshots. Do not attach a real memory archive or a production graph. If a report contains a secret, do not post it in a public issue.
Check a change
Use Python 3.11 or newer. From the repository root:
python3 scripts/check_architecture.py
python3 -m unittest discover -s sample-agent/tools -p 'test_*.py'
python3 -m unittest discover -s scripts -p 'test_*.py'
The checker is read-only. Generator write-mode tests use disposable synthetic workspaces. These checks do not run the private Brain, install an agent, connect accounts or certify policy enforcement.
Keep changes focused and describe the problem, resulting behavior and checks. Documentation and diagrams should distinguish included code, documented private architecture and proposed work. Do not add automatic boot hooks, background services or account actions to this sample.
For a defect in a linked public tool, use that tool’s own repository and instructions. Follow Arcturion Technologies for the public work; stars, thoughtful issues and reproducible improvements help others find and assess it.