Review comments fixes

helidon-io · Aug 8, 2023 · 4a3fd3a · 4a3fd3a
1 parent e47f8e9
commit 4a3fd3a
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/DEV-GUIDELINES.md b/DEV-GUIDELINES.md
@@ -70,7 +70,7 @@ Some of these rules are enforced by checkstyle, some are checked during code rev
         2. Default: component has a well defined and documented default value for such a property
         3. Optional: component behaves in a well defined and documented manner if such a property is not 
             configured (e.g. a component may expect tracing endpoint - if not defined, tracing may be disabled)         
-5. We have introduced `helidon-builder` module, that provides capability to generate builders that support both programmatic and configuration approach. See [helidon-builder](builder/README.md) for more details about modules, and [helidon-builder-api](builder/api/README.md) for explanation of APIs and naming rules
+5. We have introduced `helidon-builder` module, that provides capability to generate builders that support both programmatic and configuration approach. See [helidon-builder](builder/README.md) for more details about modules, and [helidon-builder-api](builder/api/README.md) for explanation of APIs and naming rules. The `Blueprint` approach should be used for all builders (and the API of the prototype). Exceptions must be consulted with project architect (this may result in either changing the processor to support the required feature, or in removing such feature and redesigning the problem, or in an exception (documented) to the rule)  
 
 Example: [io.helidon.nima.faulttolerance.RetryConfigBlueprint](nima/fault-tolerance/fault-tolerance/src/main/java/io/helidon/nima/faulttolerance/RetryConfigBlueprint.java)
 

diff --git a/builder/api/README.md b/builder/api/README.md
@@ -139,7 +139,7 @@ Example: `TypeName` would have the following structure (as can be seen in the [b
 
 ### Blueprint -> Prototype -> Runtime type
 For cases, where the `Prototype` serves as a configuration object of a runtime type (such as `WebServerConfig`, `RetryConfig`),
-the prototype name has a `Config` suffix, and the runtime type is a name of the type we represent.
+the prototype name should have a `Config` suffix, and the runtime type is a name of the type we represent.
 
 Example: `Retry` would have the following structure (can be seen in Fault Tolerance):