Thanks for your interest in Plasma — the open-source real-time intelligence platform. This guide applies across all repositories in the plasmash organization.
- Report bugs and request features via the relevant repository's issues.
- Ask questions / share ideas in Discussions.
- Improve docs — both repository READMEs and docs.plasma.sh.
- Submit code — fixes, new components, or new packages.
- Toolchain — the
plasmactlCLI and its plugins (plasmactl-model,plasmactl-component,plasmactl-platform,plasmactl-node,plasmactl-topology,plasmactl-processors). Mostly Go. - Packages — domain bundles of components (
plasma-core,plasma-work, …), published progressively. - Models — platform compositions built from packages (e.g.
ta, The Agency).
See docs.plasma.sh for the architecture and concepts.
Install the CLI:
curl -sSL https://get.plasma.sh | shPrerequisites: Docker and Git (Linux, macOS, or Windows). For Go plugins you'll also need a recent Go toolchain.
- Fork the repository and create a topic branch from the default branch.
- Keep changes focused; one logical change per PR.
- Use Conventional Commits for commit messages (
feat:,fix:,refactor:,docs:, …). Keep history clean — no "wip" commits. - Make sure builds/tests pass and update docs when behavior changes.
- Open the PR with a clear description of the what and why.
Be respectful and constructive. Harassment or abusive behavior is not tolerated.
Plasma is licensed under the EUPL-1.2. By contributing, you agree that your contributions are licensed under the same terms. The EUPL is copyleft, OSI-approved, and compatible with GPL and other major licenses.