Skip to content

CodeShayk/FeatureOne

Repository files navigation

ninja FeatureOne v5.0.0

GitHub Release License: MIT build-master CodeQL .Net

.Net Library to implement feature toggles.

Nuget Packages

Package Latest Details
FeatureOne NuGet version Provides core funtionality to implement feature toggles with no backend storage provider. Needs package consumer to provide IStorageProvider implementation. Ideal for use case that requires custom storage backend. Please see below for more details.
FeatureOne.SQL NuGet version Provides SQL storage provider for implementing feature toggles using SQL backend.
FeatureOne.File NuGet version Provides File storage provider for implementing feature toggles using File System backend.

Concept

What is a feature toggle?

Feature toggle is a mechanism that allows code to be turned “on” or “off” remotely without the need for a deploy. Feature toggles are commonly used in applications to gradually roll out new features, allowing teams to test changes on a small subset of users before releasing them to everyone.

How feature toggles work

Feature toggle is typically a logical check added to codebase to execute or ignore certain functionality in context based on evaluated status of the toggle at runitme.

In code, the functionality to be released is wrapped so that it can be controlled by the status of a feature toggle. If the status of the feature toggle is “on”, then the wrapped functionality is executed. If the status of the feature toggle is “off”, then the wrapped functionality is skipped. The statuses of each feature is provided by a store provider external to the application.

The benefits of feature toggles

The primary benefit of feature flagging is that it mitigates the risks associated with releasing changes to an application. Whether it be a new feature release or a small refactor, there is always the inherent risk of releasing new regressions. To mitigate this, changes to an application can be placed behind feature toggles, allowing them to be turned “on” or “off” in the event of an emergency.

Getting Started?

i. Installation

Install the latest nuget package as appropriate.

FeatureOne - for installing FeatureOne for custom IStorageProvider implementation.

NuGet\Install-Package FeatureOne

FeatureOne.SQL - for installing FeatureOne with SQL storage provider.

NuGet\Install-Package FeatureOne.SQL

FeatureOne.File - for installing FeatureOne with File system storage provider.

NuGet\Install-Package FeatureOne.File

ii. Developer Guide

Please see Developer Guide for details on how to implement schemio in your project.

Support

If you are having problems, please let me know by raising a new issue.

License

This project is licensed with the MIT license.

Version History

The main branch is now on .NET 8.0. The following previous versions are available:

Version Release Notes Developer Guide
v4.0.0 Notes Guide
v3.0.0 Notes Guide
v2.0.0 Notes Guide

Credits

Thank you for reading. Please fork, explore, contribute and report. Happy Coding !! :)