Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (24 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1.89 KB
Raw

Contributing

Scope

This repository owns the Hermes substrate_wiki plugin, its local state machinery, build/installer tooling, tests, release artifacts, and user documentation. Server routes, persistence, deployment, and production data belong in Substrate-memory/Substrate-v2.

Workflow

  1. Create a branch from main.

  2. Add regression tests before changing behavior.

  3. Keep the runtime standard-library-only unless an explicit reviewed decision changes that boundary.

  4. Run:

    python -m pip install -e '.[dev]'
pytest -q
python -m compileall -q src scripts
python scripts/verify_public_plugin_candidate.py --root . --layout destination

  5. Update CHANGELOG.md and compatibility/security docs when behavior changes.

  6. Sign every commit with the Developer Certificate of Origin 1.1 by adding Signed-off-by: Name <email> (git commit -s). This repository uses DCO sign-off, not a contributor license agreement.

  7. Open a PR. Every PR requires an adversarial review and passing CI.

Compatibility

Do not claim a Hermes or server version based on import success alone. Provider discovery, lifecycle hooks, tool schemas, profile isolation, import service, configuration, replay, rollback, and failure behavior must all pass.

Breaking server behavior requires a new protocol/schema identifier with concurrent old-version support. Never silently rewrite user configuration or state.

Releases

Release versions and immutable artifact paths are write-once. Release archives must identify a committed source tree. Never rebuild an old version and present different bytes under the same tag. See docs/releasing.md.

Sensitive material

Only synthetic fixtures are allowed. Never commit credentials, private history, customer data, private endpoints, or production evidence. Use the private vulnerability-reporting flow for security findings.