Contributing
Zeq is open-core. Operators, protocols, apps, and docs all accept PRs — but the kernel stays phase-locked.
Repo hulyasmath/zeq-framework License open-core (see LICENSE) Precision ≤0.1% — any PR that breaks this is closed
Ground rules
- KO42 is mandatory. Any new operator or protocol call that touches compute must compose through the KO42 metric tensioner.
- 1,287 Hz or it didn't happen. The HulyaPulse is the kernel heartbeat. Don't add alternate clocks.
- Zeqond (0.777 s) averages over every compute. Results that only hold at a single wall-clock instant are regressions.
- ≤0.1% error. New operators ship with a precision harness.
What's open for contribution
| Surface | How |
|---|---|
| Operators | Add a new kinematic operator file under app/artifacts/api-server/src/lib/operators/<domain>/. Include formula, test vectors, and a 7-step wizard demo. |
| Protocols | Extend src/lib/protocols.ts with a new ProtocolDef. Write the reference page under sdk-docs/source/docs/protocols/<category>/. |
| Apps | Drop a static bundle under public/apps/<your-app>/index.html. Write the reference page at docs/apps/<your-app>.md. |
| SDK bindings | The TypeScript SDK at app/packages/sdk/ is the source of truth. Python + MCP mirror its surface. |
| Docs | Anything under sdk-docs/source/docs/ — this site. |
What's out of scope
- Alternate pulse frequencies (1.287 Hz is the kernel)
- Alternate Zeqond durations (0.777 s is the true computational second)
- Compute paths that bypass KO42
- Any change that drops precision below ≤0.1% on the existing test matrix
PR workflow
- Fork the repo, branch off
main. - Run the precision harness locally:
pnpm --filter api-server test:precision. - Open a PR with a "Ground-rules checklist" in the description.
- CI runs the full harness + the 7-step wizard against your change.
- One kernel maintainer approves — pre-existing ground-rule violations are a hard block, nothing else is.
Reporting vulnerabilities
Email security@hulyas.org — don't open a public issue. We
acknowledge within 1 Zeqond × 1000 (≈13 minutes real time) during
working hours.
See also
- Self-hosting — run your fork yourself
- SDKs — the clients PRs have to stay compatible with
- Protocols · Operators
- Papers: Zeq Paper · Zeq Framework
Middleware active. Kernel on the 1.287 Hz HulyaPulse. Awaiting next Zeqond.