Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.charmos.io/llms.txt

Use this file to discover all available pages before exploring further.

Charm is an open-source project for people building AI agents, tools, documentation, runtime infrastructure, and developer workflows. We want contributors to feel safe asking questions, proposing changes, reviewing code, and disagreeing constructively. This page explains the standards expected in Charm community spaces, including GitHub repositories, pull requests, issues, discussions, Discord, docs contributions, release planning, and other project-managed channels.

Our Pledge

We pledge to make participation in Charm respectful, inclusive, and productive for contributors of all backgrounds and experience levels. Maintainers and contributors are expected to act with empathy, patience, professionalism, and care for the broader community.

Expected Behavior

  • Be respectful and constructive.
  • Keep feedback focused on the work, not the person.
  • Assume good intent, but be willing to adjust when your words or actions cause harm.
  • Ask clarifying questions before escalating disagreement.
  • Credit others for ideas, bug reports, designs, and contributions.
  • Help newcomers find the right docs, issues, discussions, or maintainers.
  • Respect project scope, maintainer time, and review boundaries.
  • Disclose conflicts of interest when relevant to a technical or governance decision.

Unacceptable Behavior

  • Harassment, threats, intimidation, or personal attacks.
  • Discriminatory language or behavior.
  • Sexualized language, imagery, or attention.
  • Publishing private information without clear permission.
  • Repeatedly derailing technical discussions.
  • Insulting, dismissive, or bad-faith review behavior.
  • Spam, trolling, or deliberately disruptive activity.
  • Pressure to bypass security, review, release, or safety processes.
  • Any behavior that makes the project unsafe for contributors.

Reporting a Concern

If you experience or witness behavior that violates this code of conduct, contact the maintainers privately:
  • Email: team@charmos.io
  • Discord: privately contact a Charm maintainer if email is unavailable.
Please include:
  • What happened.
  • Where it happened.
  • Who was involved.
  • Any relevant links, screenshots, or timestamps.
  • Whether there is an immediate safety concern.
Do not post sensitive reports publicly in GitHub issues or Discord channels.

Enforcement

Maintainers may take action to protect the community, including:
  • clarifying expectations,
  • editing or removing comments,
  • closing or locking issues and pull requests,
  • requesting a behavior change,
  • issuing a warning,
  • temporarily restricting participation,
  • permanently banning a participant from project spaces.
Enforcement decisions should be proportionate to the behavior, the impact on others, and any pattern of repeated conduct.

Appeals

If you believe an enforcement action was made in error, email team@charmos.io with context. A maintainer who was not directly involved in the original decision should review the appeal when possible.

Security Reports

Security vulnerabilities should be reported through the private process in SECURITY.md, not through public issues or public community channels.