Skip to content
This repository was archived by the owner on Jul 11, 2023. It is now read-only.

Commit a241cba

Browse files
authored
contrib: add guideline for design docs (#4757)
Adds a guideline for design docs. Signed-off-by: Shashank Ram <[email protected]>
1 parent ecc4e67 commit a241cba

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

CONTRIBUTING.md

+9
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ The OSM project accepts contributions via GitHub pull requests. This document ou
44

55
## Table of Contents
66

7+
- [Design Document](#design-document)
78
- [Pull Request Workflow](#pull-request-workflow)
89
- [Documentation](#documentation)
910
- [Roadmap](#roadmap)
@@ -12,6 +13,14 @@ The OSM project accepts contributions via GitHub pull requests. This document ou
1213
- [Semantic Versioning](#semantic-versioning)
1314
- [Attribution](#attribution)
1415

16+
17+
## Design Document
18+
19+
The OSM project recommends drafting a design doc in a shareable Google doc for features that significantly alter core control plane components or change the existing behavior. It is recommended to have the design doc reviewed by the OSM project maintainers and relevant stakeholders before proceeding with an implementation. The design doc must be referenced in the Github issue corresponding to the feature being requested.
20+
21+
Introduction of new custom APIs, feature changes requiring significant changes to the control plane, features impacting multiple OSM components, and refactoring work for performance optimization, are some of the examples of when a design doc is necessary.
22+
23+
1524
## Pull Request Workflow
1625

1726
The following sections describe how to contribute code by opening a pull request.

0 commit comments

Comments
 (0)