diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ab4e04984..7f7848e50 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,7 +30,7 @@ The process: 0. Sign the [OCA](https://www.oracle.com/technetwork/community/oca-486395.html) 1. Fork the repo 2. Fix an issue or create an issue and fix it -3. Create a Pull Request that fixes the issue +3. Create a Pull Request that fixes the issue. Follow [DEV-GUIDELINES](DEV-GUIDELINES.md) for a list of rules and best practices followed by project Helidon. 4. Watch your PR for pipeline results. If there are failures then fix them. 5. We will review your PR and merge as appropriate. diff --git a/DEV-GUIDELINES.md b/DEV-GUIDELINES.md index 334b8d492..67e5c08cd 100644 --- a/DEV-GUIDELINES.md +++ b/DEV-GUIDELINES.md @@ -71,7 +71,7 @@ reviewing changes done by others. configured (e.g. a component may expect tracing endpoint - if not defined, tracing may be disabled) -Example: [io.helidon.security.providers.oidc.common.OidcConfig](security/providers/oidc-common/src/main/java/io/helidon/security/oidc/common/OidcConfig.java) +Example: [io.helidon.security.providers.oidc.common.OidcConfig](security/providers/oidc-common/src/main/java/io/helidon/security/providers/oidc/common/OidcConfig.java) # Getters and Setters 1. We do not use the verb, e.g. when a property "port" exists, the following methods are used: @@ -81,7 +81,7 @@ Example: [io.helidon.security.providers.oidc.common.OidcConfig](security/provide 1. Default is without a verb (e.g. authenticate(boolean atn), boolean authenticate()) 2. If this would be ambiguous, we can use verb to clear the meaning (e.g. isAuthenticated() or shouldAuthenticate()) -Example: [io.helidon.security.providers.oidc.common.OidcConfig](security/providers/oidc-common/src/main/java/io/helidon/security/oidc/common/OidcConfig.java) +Example: [io.helidon.security.providers.oidc.common.OidcConfig](security/providers/oidc-common/src/main/java/io/helidon/security/providers/oidc/common/OidcConfig.java) # Fluent API 1. We use fluent API where applicable