#26 Add feature name advice

bestit · Apr 10, 2018 · f864f6e · f864f6e
1 parent b198249
commit f864f6e
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+## Unreleased
+### Fix
+- \#27 Fix route xml in documentation @migo315
+
+### Added
+- \#26 Add feature name advice in documentation @migo315
+
 ## [3.0.1]
 ### Fix
 - Add service alias for `Flagception\Manager\FeatureManagerInterface` for fixing autowiring @hanishsingla

diff --git a/docs/usage.md b/docs/usage.md
@@ -116,6 +116,12 @@ If you request an action with inactive feature flag, you will get a `NotFoundHtt
 
 Take a look to the detail documentation for [Twig](twig.md), [Route](route.md) or [Annotation](annotation.md) usage.
 
+##### Feature names
+You can name your features as you like. But we recommend using [snake case](https://en.wikipedia.org/wiki/Snake_case).
+Especially because Symfony normalizes values from your YML or XML into snake case (see [here](http://symfony.com/doc/current/components/config/definition.html#normalization)).
+Your feature "flag-a" becomes "flag_a". So you have to check for "flag_a" everywhere in your code, even if you've 
+actually maintained "flag-a" in your YML / XML. Consider this with your feature naming.
+
 Constraint usage
 -------------------------
 In some cases will you need more instead of a simple true / false. So you can define constraints to enable or disable a feature.