Skip to content

Contributing

Jeremy Longworth edited this page Sep 4, 2026 · 1 revision

Contributing

Contributions should improve logistics reasoning quality, source discipline, validation, documentation, or public usability.

Before Contributing

Read:

  • ROADMAP.md
  • CONTRIBUTING.md
  • docs/architecture/domain-contract.md
  • docs/architecture/master-taxonomy-v1.md
  • docs/standards/skill-authoring-standard.md
  • docs/standards/research-and-evidence-standard.md
  • docs/standards/calculation-standard.md
  • docs/standards/testing-standard.md

Pull Request Expectations

State:

  • which roadmap wave or hardening goal the change advances;
  • which domain, skillset, specialization, or public document it touches;
  • which artifacts changed;
  • what evidence or source material was used;
  • what validation was run;
  • known limitations, assumptions, unresolved risks, or follow-up work.

Run:

.\scripts\validate-all.ps1

Good Contributions

  • Add missing tests or fixtures for existing skills.
  • Improve calculation examples and expected results.
  • Add source metadata or source freshness checks.
  • Clarify trigger and non-trigger boundaries.
  • Tighten safety, regulatory, and approval boundaries.
  • Improve public documentation without duplicating source-of-truth files.

Avoid

  • Broad omnibus skills.
  • Unsourced regulatory claims.
  • Jurisdiction mixing.
  • Hidden approvals.
  • Empty future directories.
  • Copied source text without need.
  • Customer, shipment, facility, personnel, credential, or security-sensitive data in public issues.

Clone this wiki locally