Start here
Pats are reusable packages for the Kirn ecosystem. A Pat is developed in its own repository, built and released from that repository, and then discovered through the Pats registry.
Two contribution paths
Publish a new Pat
Use this path when you have a package to share:
- Create a Pat project with
kirn new pats <patname>. - Push that project to your own GitHub repository.
- Run its tests and build checks.
- Create a
v*tag. - Let the generated
kirn-pats-release.ymlworkflow build and publish the release. - Follow the maintainer’s registration or organization-invitation instructions.
Continue with Create your Pat.
Improve this registry repository
Use this path for documentation, registry tooling, workflow, or policy changes:
- Fork
pats-registry/pats. - Clone your fork and add the upstream remote.
- Create a focused branch.
- Make and test the change.
- Push the branch to your fork.
- Open a pull request against
pats-registry/pats:main.
Continue with Fork and clone.
A rule worth remembering
Do not add a Pat by manually inserting an entry into registry.toml. The repository README defines it as an index-only file; Pat registration follows the release and maintainer workflow.