Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 3.08 KB

CONTRIBUTING.md

File metadata and controls

55 lines (37 loc) · 3.08 KB

Contributing to CDF SIG Platform Engineering

Thank you for your interest in contributing to the CDF SIG Platform Engineering. This SIG is an open, community-driven group and welcomes contributions from practitioners at all experience levels.

Ways to Contribute

Join the Conversation

  • Attend SIG meetings (schedule and connection details in the SIG repository)
  • Join the CDF Slack workspace and find the SIG Platform Engineering channel (channel name to be confirmed)
  • Subscribe to the SIG mailing list at lists.cd.foundation (mailing list pending)

Propose or Discuss Topics

  • Open a GitHub issue to propose a new topic, raise a question, or identify a gap in existing content
  • Add agenda items to upcoming meeting notes
  • Share experience reports, case studies, or tooling evaluations relevant to platform engineering

Contribute Content

  • Review open pull requests and provide feedback
  • Draft new sections for the Platform Engineering Guide
  • Contribute reference architectures, diagrams, or golden path templates
  • Improve existing documentation for clarity, accuracy, or completeness
  • Add yourself to the Members list in README.md once you've attended a meeting

Present to the SIG

  • Give a lightning talk or full presentation on a platform engineering topic at a SIG meeting
  • Share how your organization uses CDF projects in your internal developer platform
  • Demonstrate tooling integrations or proof-of-concept implementations

Contribution Process

  1. Open an issue to discuss your proposed contribution before writing significant content. This avoids duplicate effort and ensures alignment with the SIG roadmap.
  2. Fork the repository and create a branch for your changes.
  3. Submit a pull request with a clear description of what you've added or changed and why.
  4. Request a review from a SIG maintainer. At least one maintainer approval is required to merge.
  5. Respond to feedback during the review process.

Content Guidelines

  • All content must remain vendor-neutral. Do not promote specific commercial products. Open-source tooling should be referenced by project name and linked to the project's official repository or website.
  • Write for practitioners. Assume your reader is a platform engineer or DevOps practitioner—explain the why behind recommendations, not just the what.
  • Use plain, clear language. Avoid jargon where simpler terms work equally well.
  • Include real examples where possible. Reference architectures, workflow diagrams, and code snippets make guidance actionable.
  • Attribute external sources properly. If referencing frameworks (DORA, NIST, CNCF), link to the original source.

Code of Conduct

All contributors are expected to follow the CDF Code of Conduct. The SIG is committed to maintaining a welcoming, inclusive, and respectful community.

Questions

If you have questions about contributing, open an issue in this repository or reach out on the CDF Slack.