Skip to content

Contributing

Karni's contribution guide lives in the repository, next to the code it describes: CONTRIBUTING.md. The short version:

  • Bugs: open an issue with a minimal reproduction. Security problems: never an issue — see Security.
  • "Karni should have provided this": use the Friction issue template and show the project code you had to write. These reports are how the framework grows.
  • New abstractions need three real occurrences of the pattern, an escape hatch, and an issue first.
  • Breaking changes ship with a changelog entry, a codemod when they are mechanical, a deprecation warning and a migration note — that is what makes karni upgrade work. See the stability promise.
  • make test lint typecheck must pass; generated files (docs/cli.md, docs/errors.md, docs/settings.md, docs/ui.md, the schema snapshot) are regenerated, never hand-edited.

Everyone taking part follows the Code of Conduct. Karni is licensed under the Apache License 2.0; contributions are accepted under the same licence, with no CLA.