跳到正文
cccskills
免费在 GitHub 公开

feature-flag

Registers a feature flag as additive-only and verifies the flag-off path still matches the previous default. Use whenever adding or extending a feature flag, editing FeatureFlags.cs, changing feature_flags in assembler.yml, gating a code path behind a FEATURE_* environment variable, or enabling a flag in an environment. Do not skip this skill for flag work even if the user does not name it.

中文简介正在准备中。当前显示原文说明。

elastic/docs-builder星标 25(GitHub 25 + cccskills 0)

实测评分 未实测

查看安装方法

包含的文件(1)

  • SKILL.md2.9 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

Feature Flag Skill

A feature flag is additive. Flag off keeps the previous default. Flag on adds new behavior only.

When to use

Read this skill before you add any of these:

  • A typed flag on FeatureFlags
  • A feature_flags YAML key
  • A FEATURE_* environment override
  • An if (flag) around a code path

How flags work

  • Typed flags live in src/Elastic.Documentation.Configuration/Builder/FeatureFlags.cs
  • Keys normalize to kebab-case. The env override is FEATURE_<UPPER_SNAKE>
  • Per-environment YAML keys live under feature_flags in config/assembler.yml as UPPER_SNAKE
  • Flags stay off unless listed. Do not enable a new flag in prod when you create it
  • PublishEnvironment.ToFeatureFlags() in src/Elastic.Documentation.Configuration/Assembler/PublishEnvironment.cs loads YAML keys through Set()
  • Follow the test pattern in tests/Elastic.Documentation.Build.Tests/FeatureFlagsTests.cs

Steps

1. Additive means

Flag off equals the previous default in behavior. Flag on adds new behavior only.

Do not move, hide, relocate, or delete existing output when you introduce the flag.

New behavior is a new panel, a new build step, or a new field. It is not a relocated copy of something that already shipped.

2. Register the flag

  1. Add a typed property on FeatureFlags. The default stays false.
  2. Add YAML keys only in the environments that opt in.
  3. Do not turn the flag on in prod as part of creating it.

3. Gate only the new path

Put the if (flag) around new code. Leave the existing branch as it was.

Shared markup, layout, and data wiring that the old path still needs stay outside the flag.

4. Verify additivity before you finish

This step is required. Do not skip it.

  1. List every existing surface the change touches. Include render paths, CLI output, build steps, API payloads, mobile and desktop, and assembler vs isolated builds.
  2. For each surface, compare the flag-off branch to the pre-change code or output.
  3. If anything that already shipped is missing, moved, or changed when the flag is off, stop. Restore it on the default path.

5. Prove it with tests

  • The flag defaults to false.
  • Flag-off preserves existing behavior.
  • Flag-on shows the new behavior.
  • Sibling flags stay unchanged.
  • Prod, or the default environment, does not enable the new flag.

6. Stop conditions

Do not ship a flag whose existing behavior lives only on the new path.

Do not treat "the new path has it" as coverage for the old path.

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

commit

免费

Stage relevant files and create a well-formed git commit for the docs-builder repo. Use this when the user asks to commit changes, save work, or create a commit.

中文简介正在准备中。当前显示原文说明。

elastic/docs-builder252026年10月26日 更新

issue

免费

File a well-formed bug report or feature request. Use when the user asks to open an issue, report a bug, or request a feature in the docs-builder repo.

中文简介正在准备中。当前显示原文说明。

elastic/docs-builder252026年10月26日 更新

lint

免费

Auto-fix all formatting issues in the docs-builder repo — runs dotnet format for C# and npm fmt:write for TypeScript/JS. Use when the user asks to fix formatting, lint the code, or when a pre-commit hook fails due to formatting.

中文简介正在准备中。当前显示原文说明。

elastic/docs-builder252026年10月26日 更新

Search, analyze, and author Elastic documentation using the remote MCP server. Use this when the user asks about Elastic product documentation, features, or APIs; wants to find, read, or verify existing docs pages; is writing or editing documentation; mentions cross-links between repos; asks about documentation structure, coherence, or consistency; wants to generate templates following Elastic content type guidelines; or references elastic.co/docs URLs or Elastic product names.

中文简介正在准备中。当前显示原文说明。

elastic/docs-builder252026年10月26日 更新

pr

免费

Create a GitHub pull request for the current branch with a focused why/what body and exactly one release-drafter label. Use when the user asks to open a PR, create a pull request, or ship a branch.

中文简介正在准备中。当前显示原文说明。

elastic/docs-builder252026年10月26日 更新

Review changed or staged C# code against the docs-builder coding standards and flag violations. Use when the user asks to review code style, check for standards violations, or audit a diff before committing.

中文简介正在准备中。当前显示原文说明。

elastic/docs-builder252026年10月26日 更新

查看 elastic 的全部技能

报告此技能的问题