Skip to content

Maintaining kac

This section is for the maintainer: whoever builds, releases or forks kac, and needs to know what it is specified to do. A corpus is one repository of knowledge records kept in git. A check is one fault kac validate can report against a corpus.

Start here

Read these in order to go from a clone to a published fork.

  • Architecture says how the entrypoint, kac.core and the schema fit together, and the order a command runs in.
  • Build, test and release says how to build kac, run its unit, feature and golden test layers, and publish a version.
  • Forking lists every identifier and secret a fork replaces before it can publish the tool, the corpus packages, the plugin or the site.
  • Contributing says how a change is proposed, what a pull request owes, and which checks gate it.

Changing a part of kac

  • The documentation charter says which reader each section of this site serves, which kinds of page each section may contain, and where the argument behind a change is written.
  • Checks in C# says when a rule needs C#, how to add a fact to the expression grammar, and why a rule is data wherever it can be.
  • Adding a report is the order to follow when you add a report to kac report.

What kac is specified to do

Each specification page lists what one part of kac does, refuses and promises a consumer. It ends with the Reqnroll scenarios that prove each behaviour, and the behaviours no scenario proves yet. ScenarioCitationTests fails a scenario no page cites.

  • Discovery: how kac finds a corpus, its schema and its files.
  • Validation: what kac validate reports, and what kac checks lists.
  • Generation: what kac generate writes.
  • Export: what kac export writes for a consumer.
  • The plugin bundle: what kac bundle assembles, and how it lays the plugin out.
  • Pack and restore: how a corpus is packaged, and how a consumer fetches one.
  • Imports: what a corpus consuming another receives.
  • Layers and update: how kac new and kac update apply the template.
  • Reporting: what kac report writes.

Where to go next

Architecture is the first page to read before you change kac.