The Open Service Mesh (OSM) project fully-embraces design docs as a vehicle for feature proposals and discussion. This document describes the process for submitting a design doc and getting it accepted.
Before creating a design doc, please check the project's issues to see if there's already ongoing effort being done. If you wold like to validate your approach or get some early feedback before starting design doc, consider starting a GitHub discussion on the OSM repo or asking a question in the #openservicemesh Slack channel.
Though it's not required, feel free to use the design doc template. If you choose to forgo the design doc template, make sure the same general information is present in your design doc.
To submit a design doc, submit a PR to this repo openservicemesh/osm with the title and link to your design doc added to the index.md file in this directory. When submitting your PR, add the kind/design-doc label to it.
OSM uses the auto-assign GitHub Action to automatically assign reviewers to the design doc: 2 maintainers and 2 contributors (see the Contributor ladder for details). Those who are auto-assigned should prioritize the design doc review the same as any code PR view. Feel free to review the design doc and add yourself as a reviewer even if you aren't auto-assigned! Comments regarding the content of the design doc should be made inline on the design doc itself if the editor supports it (e.g. Google Docs). Once a reviewer finds the design doc to be satisfactory, they should approve the PR on GitHub. Upon the approval of 2 maintainers, the PR will be merged and that design doc will be considered "approved".