This repository has been archived by the owner on Jun 29, 2020. It is now read-only.
Set explicit order, default for CheckStatus enum members #88
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I would like to propose setting an explicit default value for the
CheckStatus
enum, so that uninitialized variables get the expected value ofUnknown
. This will communicate to developers that they can count on this default value.I would also like to propose ordering the enum values from lowest to highest urgency, similar to e.g.
Microsoft.Extensions.Logging.LogLevel
. This makes it trivial to do things like find the most critical result from this collection (var worst = checks.Max()
), find all checks which are warning or worse (var alerts = checks.Where(ch => ch >= CheckStatus.Warning)
), sort them by urgency, etc. This is needed when a single collection point gathers checks from multiple locations and "bubbles them up" for display, alerting, etc.I could not find anywhere in the solution that is currently depending on the order or explicit values from this enum, so there should be no negative impact from this change.