Contributing

If you are contributing to ocp, start with SPEC.md. It is the source of truth for product behavior and acceptance criteria.

Documentation expectations

The repository now has three different documentation surfaces with different jobs:

  • SPEC.md defines behavior and acceptance criteria
  • README.md stays concise and GitHub-friendly
  • the site under /docs is the comprehensive user documentation surface

When user-visible behavior changes, update the spec and whichever user-facing documentation surfaces are affected.