Skip to content

Commit

Permalink
[docs] Add guidelines for experimental modules naming (#11836)
Browse files Browse the repository at this point in the history
Adding guidelines for experimental module naming as a result of [the
vote](#11783).

Resolves #11783
  • Loading branch information
dmitryax authored Dec 11, 2024
1 parent 98f403f commit 4a987da
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/coding-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,12 @@ When naming configuration structs, use the following guidelines:
- Use the `Settings` suffix for configuration structs that are set by developers in the code. For example, `component.TelemetrySettings` ends in `Settings` since it is set by developers in the code.
- Avoid redundant prefixes that are already implied by the package name. For example, use`configgrpc.ClientConfig` instead of `configgrpc.GRPCClientConfig`.

#### Experimental module naming

Experimental modules can be introduced as submodules of stable modules. They MUST have the same name as the stable
modules prefixed with `x`. For example, `config/confighttp` module can have an experimental module named
`config/confighttp/xconfighttp` that contains experimental APIs.

### Enumerations

To keep naming patterns consistent across the project, enumeration patterns are enforced to make intent clear:
Expand Down

0 comments on commit 4a987da

Please sign in to comment.