Contributing to Vexcalibur

These pages describe how this repository is tested, released, and governed. They’re for people changing Vexcalibur itself. If you only want to generate VEX documents, the user guides cover that and you can skip all of this.

Start with the root contribution guide for branch, review, and local-gate expectations. The pages here go deeper on one area each.

Working on the code

• Python style policy — the enforceable rules, and where they diverge from the vendored Google guide

• Fuzz untrusted input boundaries — when a parser, source client, or terminal-safety boundary changes

• Vendored external documents — what’s copied in from upstream, and how it’s kept in sync

Releasing

Read these in order. The first explains why the release process looks the way it does, and the rest are runbooks.

• Why Vexcalibur publishes evidence about itself

• Build and review local release evidence

• Publish Vexcalibur to GitHub and PyPI

• Release-evidence reference — the evidence file formats, which are maintained by this repository and are not part of the package’s Python API

Automation and governance

• CI, release, and recurring automation

• Verify GitHub governance