chore: vendor TinyBus as a submodule

Author: senamakel

.github/workflows/ci.yml

@@ -26,6 +26,7 @@ jobs:
           # This job executes repository code (cargo build/test); don't persist
           # the token in git config.
           persist-credentials: false
+          submodules: true
 
       - uses: dtolnay/rust-toolchain@stable
         with:
@@ -55,6 +56,7 @@ jobs:
       - uses: actions/checkout@v7
         with:
           persist-credentials: false
+          submodules: true
 
       - uses: dtolnay/rust-toolchain@stable
 
@@ -72,6 +74,7 @@ jobs:
       - uses: actions/checkout@v7
         with:
           persist-credentials: false
+          submodules: true
 
       - name: Read rust-version from Cargo.toml
         id: msrv
@@ -101,6 +104,7 @@ jobs:
       - uses: actions/checkout@v7
         with:
           persist-credentials: false
+          submodules: true
 
       - name: Check advisories, licenses, bans, and sources
         uses: EmbarkStudios/cargo-deny-action@v2

.github/workflows/release.yml

@@ -29,6 +29,7 @@ jobs:
       - uses: actions/checkout@v7
         with:
           fetch-depth: 0
+          submodules: true
 
       - uses: dtolnay/rust-toolchain@stable
         with:

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "vendor/tinybus"]
+	path = vendor/tinybus
+	url = https://github.com/tinyhumansai/tinybus
+	branch = main

AGENTS.md

@@ -21,6 +21,8 @@ Do this once, in a single commit, before writing feature code:
 - [ ] Confirm `license` and `LICENSE` match the project's intended license.
 - [ ] Update the security contact in `SECURITY.md`.
 - [ ] Replace `ROADMAP.md` with the real plan, or delete it.
+- [ ] Decide whether the project uses TinyBus. Keep `vendor/tinybus` pinned and
+      wire the required crate/features, or remove the submodule deliberately.
 - [ ] Rewrite the "Project Structure" section below to describe this crate.
 
 ## Project Structure
@@ -37,6 +39,7 @@ src/
     └── test.rs         # module-local unit tests
 tests/                  # integration tests against the public API only
 examples/               # runnable, compiled-in-CI usage examples
+vendor/tinybus/         # pinned TinyBus source; optional until wired by a project
 docs/
 ├── specs/              # behavior and architecture specifications
 ├── plans/              # test-first implementation plans
@@ -134,6 +137,21 @@ add one:
 Keep `Cargo.lock` committed; this crate ships a lockfile so CI and releases are
 reproducible.
 
+### Vendored dependencies
+
+TinyBus is registered as the `vendor/tinybus` git submodule and pinned by its
+gitlink. Initialize it after cloning with:
+
+```sh
+git submodule update --init --recursive
+```
+
+Do not edit vendored code from the parent repository. Make TinyBus changes in
+its own repository, push them there, then update this repository's gitlink in a
+separate commit. If the generated project consumes TinyBus, use the exact crate
+path and minimal features it needs; the template does not force that dependency
+on every generated crate.
+
 ## Testing
 
 - Module-local unit tests live in `src/<feature>/test.rs` and may touch private

CONTRIBUTING.md

@@ -7,10 +7,11 @@ this document is the short path through them.
 ## Development Setup
 
 Install a stable Rust toolchain with Rust 2024 support (see `rust-version` in
-`Cargo.toml` for the minimum supported version), then run the four checks CI
-runs:
+`Cargo.toml` for the minimum supported version), initialize the vendored
+submodules, then run the four checks CI runs:
 
 ```sh
+git submodule update --init --recursive
 cargo fmt --all -- --check
 cargo clippy --all-targets --all-features -- -D warnings
 cargo build --all-targets --all-features

Cargo.toml

@@ -11,7 +11,15 @@ readme = "README.md"
 keywords = ["template"]
 categories = ["development-tools"]
 # Keep the published package to what a consumer actually needs.
-exclude = [".github/", "docs/", "worktrees/", ".env.example", "deny.toml"]
+exclude = [
+    ".github/",
+    ".gitmodules",
+    "docs/",
+    "vendor/",
+    "worktrees/",
+    ".env.example",
+    "deny.toml",
+]
 
 [dependencies]
 # Derive macros for the crate-wide error type in `src/error/mod.rs`. Every

README.md

@@ -31,6 +31,7 @@ template-specific value.
 | Release | Manual `workflow_dispatch` bump that validates, versions, tags, and publishes to crates.io |
 | Community | Issue and pull request templates, Dependabot, contributing, security, support, and code of conduct docs |
 | Agents | [`AGENTS.md`](AGENTS.md) as the single source of truth, symlinked as `CLAUDE.md`, plus a `.claude/settings.json` allowlist for the standard commands |
+| Vendor | TinyBus pinned as the `vendor/tinybus` submodule, initialized by CI and release workflows |
 
 ## Layout
 
@@ -47,6 +48,8 @@ tests/
 └── public_api.rs       # integration tests against the public API only
 examples/
 └── basic.rs            # compiled and linted in CI
+vendor/
+└── tinybus/            # pinned TinyBus git submodule
 docs/
 ├── README.md           # documentation index and conventions
 ├── specs/              # behavior and architecture specifications
@@ -61,6 +64,12 @@ Feature areas use directory modules: implementation and exports live in
 
 ## Development
 
+Clone with submodules, or initialize them before building:
+
+```sh
+git submodule update --init --recursive
+```
+
 ```sh
 cargo fmt --all -- --check
 cargo clippy --all-targets --all-features -- -D warnings