Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (35 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

49 lines (35 loc) · 1.68 KB
Raw

Contributing

Thanks for improving this Hermes profile distribution.

Etiquette

  1. In order to accomodate the maximum number of first-time contributors, please limit yourself to ONE help-wanted or bounty issue at a time.
  2. Agent PRs are welcomed and accepted as long as they are high quality.
  3. Please fork and star the repo prior to raising a pull request.

Development loop

  1. Inspect the current repository state.
  2. Make focused changes.
  3. Run validation:
python3 scripts/validate_profile.py .
  1. Run generator smoke tests when scripts, templates, or default profile files change:
python3 scripts/generate_profile.py \
  --params templates/profile.params.yaml \
  --output /tmp/profile-template-smoke
python3 /tmp/profile-template-smoke/scripts/validate_profile.py /tmp/profile-template-smoke
  1. For release-relevant changes, bump distribution.yaml and add a matching CHANGELOG.md entry.

Profile quality bar

A good profile distribution has:

  • Clear SOUL.md identity, mission, boundaries, and output contract.
  • Safe config.yaml defaults with credentials kept outside git.
  • Reusable bundled skills with valid SKILL.md frontmatter.
  • Accurate distribution.yaml metadata.
  • README install and validation instructions.
  • No runtime state, secrets, local caches, or private user data.

Pull request checklist

  • python3 scripts/validate_profile.py . passes.
  • Generated profile smoke test passes when relevant.
  • Version and changelog are updated for release-relevant changes.
  • New docs do not claim unconfigured tools, credentials, community links, or integrations.
  • No secrets, runtime files, or local caches are committed.