Thank you for your interest in contributing to the System Topology Manifest (STM) project. This document outlines how to contribute changes, report issues, and propose improvements.
STM is a descriptive topology layer. Contributions should preserve that scope.
-
Fork the repository and clone it locally.
-
Create a feature branch:
git checkout -b feature-name
-
Make changes following existing structure and schema rules.
-
Validate JSON/YAML against provided schemas.
-
Commit with a clear message:
git commit -m "Describe topology/schema change" -
Push your branch and open a pull request.
Small, focused PRs are preferred.
Large changes should be discussed before implementation.
STM is strictly descriptive.
Valid contributions include:
- system or application declarations
- signal definitions (inputs, outputs, triggers)
- schema improvements
- documentation clarifications
STM does not define:
- architecture rules
- guardrails or enforcement
- coding standards
- runtime or deployment behavior
Those concerns belong to the System Architecture Manifest (SAM).
When reporting issues:
- Check existing issues first
- Clearly describe the problem
- Include examples or schema references if applicable
- Follow existing schema conventions
- Avoid introducing prescriptive logic
- Update documentation if behavior or meaning changes
- Reference related issues when applicable
STM is an open project and welcomes thoughtful, scoped contributions.
Thank you for helping keep system topology clear, accurate, and machine-readable.