From b70d91139c1706ff58aeb4c4257b3827d6c8b3bb Mon Sep 17 00:00:00 2001 From: bpaulien Date: Wed, 11 Dec 2024 12:08:05 -0500 Subject: [PATCH] Update feature-flags.md title case, punctuation, added clarifying words --- docs/contributing/project-details/feature-flags.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/contributing/project-details/feature-flags.md b/docs/contributing/project-details/feature-flags.md index 1c9571b1d..40a225d02 100644 --- a/docs/contributing/project-details/feature-flags.md +++ b/docs/contributing/project-details/feature-flags.md @@ -1,8 +1,8 @@ -# Feature Flags (experimental features) +# Feature Flags (Experimental Features) Feature flags (experimental features) are a way to enable or disable certain features in the application. This is useful when you want to test a feature with a small group of users before rolling it out to everyone. It is also useful when building a larger feature as it allows breaking it up in to smaller releasable chunks. -For example: custom reports initially was released as a read-only version under a feature flag. Later the saving functionality was added. This allowed to put the feature in the hands of real users before announcing it as a stable first-party feature. +For example: `custom reports` initially was released as a read-only version under a feature flag. Later the saving functionality was added. This allowed us to put the feature in the hands of real users before announcing it as a stable first-party feature. In short, feature flags allow: @@ -11,7 +11,7 @@ In short, feature flags allow: However, feature flags also have a downside. They can make the code more complex and harder to understand. They can also lead to technical debt if not managed properly. As such - we impose a strict policy for managing them. -**Experimental features that have not had any active development for over 3 months will be removed from the codebase.** This is to ensure the codebase does not become cluttered with unfinished features. If you wish to bring back an experimental feature that was removed - please free to bring it back as long as you can commit to helping with finishing it up for a first-party release. +**Experimental features that have not had any active development for over 3 months will be removed from the codebase.** This is to ensure the codebase does not become cluttered with unfinished features. If you wish to bring back an experimental feature that was removed - please feel free to bring it back as long as you can commit to helping with finishing it up for a first-party release. Before removing an experimental feature flag - we will try our best to communicate with the original engineer/s who implemented it. However, if we cannot reach them - we will remove the feature flag.