Skip to content

Contributing ​

Report wrong output, a repair prompt or a missing accessor through the new-issue chooser. Errors and warnings says which failures are worth a report. Security issues go through SECURITY.md, never a public issue.

CONTRIBUTING.md covers setting up the repository, the git hooks, the scope it is maintained for, reporting a bug or promoting a downstream need, and installing an unreleased commit.

The documentation for working on the repository is read on GitHub:

  • Development guide: setup, source layout, generated outputs, and contribution rules.
  • Testing guide: the gate matrix, git hooks and CI jobs, the test suites, coverage, schema validation, and the oracles behind a PowerPoint claim.
  • Architecture: how the library is structured and where each responsibility lives.
  • Scope and design policy: what the library leaves out on purpose, the areas outside active development, and the rule for escape hatches.
  • OOXML agent context: where to look up OOXML and PowerPoint behavior before changing emitted XML, and what counts as evidence for a change.
  • Release workflow: how a release reaches npm under both package names, and how to finish a half-published one.
  • Design pages: how animations, embedded fonts, embedded objects, fills and measured text fit are written and read.