Skip to content

Help and contributing

Start with the quickstart or troubleshooting guide. Built-in help describes the commands available in the installed version:

Terminal window
hansard help
hansard help <command>
hansard doctor

The command reference groups commands by task. The source guides explain what each importer can preserve and where its coverage stops.

  1. Record the Hansard version with hansard --version.
  2. Record the operating system and CPU architecture.
  3. Identify the affected agent app or CLI and its version.
  4. Write a small reproduction with invented provider data.
  5. State the expected result.
  6. State the actual result.

Diagnostic output can contain paths, configuration details, and account identifiers. Review every excerpt before sharing it. Do not attach real transcripts, raw archives, credentials, session identifiers, or identifying screenshots. Reconstruct a synthetic example instead of redacting a real one.

Source distributions include these policies at the repository root:

File Purpose
SUPPORT.md Questions, defects, feature requests, and importer requests.
CONTRIBUTING.md Development setup, isolated tests, and contribution review.
SECURITY.md Supported security versions and private vulnerability reporting.
CODE_OF_CONDUCT.md Participation expectations and conduct reporting.
GOVERNANCE.md Project decisions and maintainer responsibilities.
CITATION.cff Software attribution for research.

These source policies are separate from the npm package. Use the repository’s support channels when available. A suspected vulnerability belongs in private reporting, never in a public bug report. GitHub documents its private vulnerability reporting process. If the repository has no private reporting button, request that it be enabled without including vulnerability details.