# astrid-runtime/handbook **Attribution required: if you use, quote, or summarise this content, you must credit and link back to [awesome-repositories.com](https://awesome-repositories.com/repository/astrid-runtime-handbook).** _How this analysis was created: the description and tags below were written by an AI model that read this project's README and public documentation pages; stars, license and language come straight from the GitHub API. The model does not read the source code._ 7,390 stars · 42 forks · Apache-2.0 ## Links - GitHub: https://github.com/astrid-runtime/handbook - Homepage: https://astrid-runtime.github.io/handbook/ - awesome-repositories: https://awesome-repositories.com/repository/astrid-runtime-handbook.md ## Description This repository is the contributor handbook for the Astrid runtime, a runtime split across many separate repositories. It explains how to contribute: where each piece of code lives, how the parts fit together, and which rules govern changes. The handbook is written as source files and compiled into a searchable, browsable online book. The guidance covers the project's contribution governance. Contributors choose a contribution tier that matches the scope of their change, and they sign their commits. Core pull requests are linked to closed issues, and contributors review their own changes adversarially before asking for review, with extra scrutiny on security-critical code. Changes to the public contract between the core and user-facing code (binary interfaces, message schemas and permissions) go through a written RFC process before any implementation begins. Each version bump ships in its own pull request, separate from feature or fix changes. The handbook also describes the design principles behind the runtime. The kernel is kept minimal and limited to event routing, capability enforcement and sandbox execution. All other logic lives in separate components that talk to the kernel only through messages. Components run sandboxed and are granted only the capabilities they have been explicitly permitted. The documentation is built with a static site generator and can be served locally for previewing changes. The implementation is treated as the source of truth, so any documentation that disagrees with the source code is considered a bug. The work is licensed under Apache, with both copyright and patent grants. ## Tags ### Software Engineering & Architecture - [Contribution Guides](https://awesome-repositories.com/f/software-engineering-architecture/project-management-governance/project-governance/contribution-guidelines/contribution-guides.md) — Provides a written contributor guide covering repository layout, contribution tiers, review expectations and release steps. - [Contribution Workflows](https://awesome-repositories.com/f/software-engineering-architecture/development-methodologies/engineering-best-practices/open-source-collaboration/open-source-methodologies/contribution-workflows.md) — Guides contributors through choosing a contribution tier, signing commits, self-reviewing changes and linking pull requests to issues. - [Minimal Kernel Architectures](https://awesome-repositories.com/f/software-engineering-architecture/minimal-kernel-architectures.md) — Keeps the kernel limited to event routing, capability enforcement and sandbox execution, with all other logic in message-driven components. - [Minimal Kernel Design Rules](https://awesome-repositories.com/f/software-engineering-architecture/minimal-kernel-design-rules.md) — Keep the core minimal by following a rule that guides contributors on what belongs in the kernel and what belongs elsewhere in the system. ([source](https://github.com/astrid-runtime/handbook#readme)) - [Polyrepo Structures](https://awesome-repositories.com/f/software-engineering-architecture/polyrepo-structures.md) — Splits the runtime across many separate repositories, each owning one piece, joined together through shared public contracts instead of a single monolithic codebase. - [Contributor Navigation Guides](https://awesome-repositories.com/f/software-engineering-architecture/contributor-navigation-guides.md) — Explains how the runtime is split across many repositories so contributors know where each piece lives and how parts connect. - [Signed Commit and Issue Traceability Requirements](https://awesome-repositories.com/f/software-engineering-architecture/development-methodologies/engineering-best-practices/open-source-collaboration/open-source-methodologies/contribution-workflows/signed-commit-and-issue-traceability-requirements.md) — Requires signed commits and links every core pull request to a closed issue so each change is authenticated and traceable. ([source](https://astrid-runtime.github.io/handbook/)) - [Protocol Change Proposals](https://awesome-repositories.com/f/software-engineering-architecture/governance-proposal-lifecycles/language-change-proposals/protocol-change-proposals.md) — Requires a written RFC before implementation for changes to binary interfaces, message schemas and permissions that form the public contract. - [Interface Contracts](https://awesome-repositories.com/f/software-engineering-architecture/interface-contracts.md) — Treats binary interfaces, message schemas, and permissions as a stable agreement between core and user-facing code, with changes gated by a written proposal. - [Message-Passing Component Isolation](https://awesome-repositories.com/f/software-engineering-architecture/message-passing-component-isolation.md) — Keeps the core limited to event routing, capability enforcement and sandboxing, moving all other logic into components that communicate by messages. ([source](https://astrid-runtime.github.io/handbook/)) - [Polyrepo Organization](https://awesome-repositories.com/f/software-engineering-architecture/polyrepo-organization.md) — Explain how the code is split across multiple repositories so contributors know where each piece lives and how the parts fit together. ([source](https://github.com/astrid-runtime/handbook#readme)) - [RFC Proposal Processes](https://awesome-repositories.com/f/software-engineering-architecture/rfc-proposal-processes.md) — Propose significant changes through a written request for comments, following set trigger conditions and steps before any implementation begins. ([source](https://github.com/astrid-runtime/handbook#readme)) ### Part of an Awesome List - [Open Source Contribution](https://awesome-repositories.com/f/awesome-lists/devtools/open-source-contribution.md) — Sets rules for contribution tiers, signed commits, issue-linked pull requests, self-review and separate version bumps under an Apache license. ### Content Management & Publishing - [Static Documentation Sites](https://awesome-repositories.com/f/content-management-publishing/static-documentation-sites.md) — Compile handbook source files into a navigable, searchable online book so contributors can read the guidance in a browsable form. ([source](https://github.com/astrid-runtime/handbook#readme)) ### Development Tools & Productivity - [Contribution Workflows](https://awesome-repositories.com/f/development-tools-productivity/contribution-workflows.md) — Walk through how to contribute, covering the multi-repository layout, the keep-the-core-minimal principle, contribution tiers, when to propose changes, and the release process. ([source](https://github.com/astrid-runtime/handbook/blob/main/README.md)) - [Static Site Documentation](https://awesome-repositories.com/f/development-tools-productivity/documentation-generators/static-site-documentation.md) — Compiles source files into a searchable, browsable online book using a static site generator that can be served locally for preview. ### Security & Cryptography - [Capability-Based Access Controls](https://awesome-repositories.com/f/security-cryptography/capability-based-access-controls.md) — The core grants access only through explicit capabilities, so every component can perform just the actions it was specifically permitted to do. - [Sandboxed Component Execution](https://awesome-repositories.com/f/security-cryptography/sandboxed-component-execution.md) — Runs untrusted component code inside an isolated environment managed by the core, so extensions cannot affect the host or each other directly.