Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
99 lines (67 loc) · 3.2 KB

CONTRIBUTING.md

File metadata and controls

99 lines (67 loc) · 3.2 KB
Raw

Contributing to Platform Intelligence Playbook

This is a proposed reference architecture inviting community validation and adaptation. We welcome contributions that improve the patterns, documentation, and implementations.

How to Contribute

Report a Pattern or Failure Mode

Found a failure mode we missed? Have a success pattern to share?

  1. Open an issue with the pattern label
  2. Describe the scenario, what happened, and what the prevention/solution looks like
  3. Include data if possible (anonymized metrics, timeline, team size)

Improve Documentation

  1. Fork the repository
  2. Create a branch: git checkout -b docs/your-improvement
  3. Make your changes
  4. Submit a pull request with a clear description of what changed and why

Add Integrations

Built an agent type, policy template, or observability configuration on this foundation?

  1. Fork the repository
  2. Create a branch: git checkout -b feature/your-integration
  3. Follow the existing directory structure and naming conventions
  4. Include a README explaining what it does and how to use it
  5. Submit a pull request

Report Lab Disasters

Safe failures teach more than polished success stories. If you've had a notable failure in a test/lab environment:

  1. Open an issue with the disaster-report label
  2. Describe what happened (anonymize sensitive details)
  3. Explain what safeguards would have prevented it
  4. We may feature it in the playbook (with credit, if desired)

Code Style

Go Code

  • Follow standard Go conventions (gofmt, go vet)
  • All Go files must start with a 2-line ABOUTME comment: 
    // ABOUTME: Brief description of what this file does.
// ABOUTME: Second line with additional context.
  • Use table-driven tests
  • Include error path testing
  • Run go test ./... before submitting

YAML/Markdown

  • YAML files use 2-space indentation
  • Markdown files use standard CommonMark
  • YAML and Markdown files should include ABOUTME headers as HTML comments: 
    <!-- ABOUTME: Description line 1 -->
<!-- ABOUTME: Description line 2 -->

Commit Messages

  • Use conventional commit format: fix:, feat:, docs:, refactor:, chore:
  • Keep the first line under 72 characters
  • Include a body explaining why for non-trivial changes

Pull Request Process

  1. Ensure your changes pass all existing tests
  2. Update documentation if your changes affect user-facing behavior
  3. Add tests for new functionality
  4. Request review from maintainers
  5. Address review feedback
  6. Maintainers will merge once approved

Code of Conduct

This project follows the CNCF Code of Conduct. Please report unacceptable behavior to the maintainers.

License

By contributing, you agree that your contributions will be licensed under the Apache License 2.0.