Skip to content

Contributing

Improve a concrete workflow or verified behavior. Keep changes focused and English instructions concise. Follow AGENTS.md and the shared workflow.

Agents and skills

  • Canonical agents: agents/<slug>.agent.md.
  • New skills: skills/<slug>/SKILL.md. Existing category topic files remain compatible source entries; exporters turn them into native skill directories.
  • Required frontmatter: name (matching the file/directory) and description (capability and selection situations). Use lowercase slugs with single hyphens.
  • Keep common metadata separate from host-specific modes, tools and permissions.
  • Put substantial examples in references/, link from the entry and load on demand.
  • Use templates/skill-template.md. Remove placeholders, keep instructions actionable and verify realistic tasks, including failure cases.

Toolkit and documentation

Keep the toolkit standard-library-only at runtime. Add meaningful unittest checks for persistence, export, API or permission changes. Update the applicable user guide. Documentation sources live in assets/mkdocs/; generated docs/ is maintained by the main workflow. Reference examples do not mandate a framework or architecture.

Pull requests

Create a branch and a reviewable PR. Explain the concrete problem, resulting behavior, relevant tradeoffs and checks actually run. Run the AGENTS.md commands and identify unavailable checks. Keep private data and generated bundles out of the diff. Merging and deployment remain separate actions.

Canonical source: CONTRIBUTING.md.