Standard naming scheme for feature flags to increase clarity
- Dominant language
- TypeScript
- Stars
- 12.9k
- Forks
- 4.6k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 74
Description
### Discussed in https://github.com/aws/aws-cdk/discussions/12576
Originally posted by **efenderbosch** January 18, 2021
It is easy to understand what the ``aws-cdk:enableDiffNoFail`` feature flag does.
However, feature flag names like ``aws-cdk/secretsmanager:parseOwnedSecretName`` are unclear. I don't know by reading the flag name if if enabling the flag will include or exclude the suffix. A better name for this flag might be ``aws-cdk/secretsmanager:excludeSecretNameSuffix``.
Contributor guide
Research direction
Start by reading discussion #12576 and comparing the referenced feature flag names, including aws-cdk:enableDiffNoFail and aws-cdk/secretsmanager:parseOwnedSecretName. Define a consistent naming scheme and identify all affected flags; done means the convention is agreed and applied consistently across the relevant flags.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100