Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add coding guideline for optional fields. #11342

Closed
wants to merge 2 commits into from
Closed

Add coding guideline for optional fields. #11342

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
443fb34
Add coding guideline for optional fields.
mackjmr Oct 3, 2024
63028be
feedback
mackjmr Oct 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,10 @@ To guarantee backward-compatible behavior, all configuration packages should sup

Users should always initialize the config struct with this function and overwrite anything as needed.

### Optional Fields

Config fields should use the normal type and rely on zero values. In cases where it is necessary to distinguish between unset values and zero values, use a pointer to the type.

### Startup Error Handling

Verify configuration during startup and fail fast if the configuration is invalid.
Expand Down
Loading