forked from open-feature/dotnet-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
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.
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
feat: Initial Proposal for Diagnostic Feature Codes in OpenFeature #3
Merged
arttonoyan
merged 3 commits into
add-dependency-injection
from
feature/add-net8-experimental-attribute-v2
Nov 9, 2024
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
39 changes: 39 additions & 0 deletions
39
src/OpenFeature.DependencyInjection/Diagnostics/FeatureCodes.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
namespace OpenFeature.DependencyInjection.Diagnostics; | ||
|
||
/// <summary> | ||
/// Contains identifiers for experimental features and diagnostics in the OpenFeature framework. | ||
/// </summary> | ||
/// <remarks> | ||
/// <c>Experimental</c> - This class includes identifiers that allow developers to track and conditionally enable | ||
/// experimental features. Each identifier follows a structured code format to indicate the feature domain, | ||
/// maturity level, and unique identifier. Note that experimental features are subject to change or removal | ||
/// in future releases. | ||
/// <para> | ||
/// <strong>Basic Information</strong><br/> | ||
/// These identifiers conform to OpenFeature’s Diagnostics Specifications, allowing developers to recognize | ||
/// and manage experimental features effectively. For more details, refer to the | ||
/// <a href="https://github.com/open-feature/dotnet-sdk/docs/diagnostics/README.md">Diagnostics Specifications</a>. | ||
/// </para> | ||
/// </remarks> | ||
/// <example> | ||
/// <code> | ||
/// Code Structure: | ||
/// - "OF" - Represents the OpenFeature library. | ||
/// - "DI" - Indicates the Dependency Injection domain. | ||
/// - "001" - Unique identifier for a specific feature. | ||
/// </code> | ||
/// </example> | ||
internal static class FeatureCodes | ||
{ | ||
/// <summary> | ||
/// Identifier for the experimental Dependency Injection features within the OpenFeature framework. | ||
/// </summary> | ||
/// <remarks> | ||
/// <c>OFDI001</c> identifier marks experimental features in the Dependency Injection (DI) domain. | ||
/// | ||
/// Usage: | ||
/// Developers can use this identifier to conditionally enable or test experimental DI features. | ||
/// It is part of the OpenFeature diagnostics system to help track experimental functionality. | ||
/// </remarks> | ||
public const string NewDi = "OFDI001"; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 3 additions & 0 deletions
3
test/OpenFeature.DependencyInjection.Tests/NoOpFeatureProviderFactory.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reminder to add this readme or a new section could be added to the root readme.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Absolutely, I’ve placed it here as an example for now. If the team decides it’s a good idea and we move forward with documenting it, I’ll update the path to the correct location (e.g., adding it to the root README or a new section). Otherwise, I’ll simply remove it. For now, I’m waiting on some feedback and approval to ensure my changes align with what the team wanted, so I can finalize everything accordingly.
And thanks for the quick response!