Skip to content

docs: add feature flag naming conventions guide - #6618

Merged
talissoncosta merged 2 commits into
mainfrom
docs/naming-conventions
Jan 30, 2026
Merged

docs: add feature flag naming conventions guide#6618
talissoncosta merged 2 commits into
mainfrom
docs/naming-conventions

Conversation

@talissoncosta

@talissoncosta talissoncosta commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add documentation for feature flag naming conventions and best practices
  • Document the regex validation feature in Project Settings
  • Include examples of common naming patterns (snake_case, kebab-case, etc.)

Changes

New file: docs/docs/best-practices/naming-conventions.md

Content includes:

  • Why naming conventions matter (features cannot be renamed)
  • Best practices: descriptive names, consistent format, useful prefixes
  • Table comparing recommended vs. not recommended names
  • How to configure regex validation in Project Settings
  • Example regex patterns for common conventions
  • Tag naming conventions

Closes #6605

Add documentation covering:
- Naming best practices (descriptive names, consistent format, prefixes)
- Examples of good vs. bad naming patterns
- How to enforce conventions using regex validation in Project Settings
- Common regex patterns for snake_case, kebab-case, etc.
- Tag naming conventions with cross-references

Closes #6605

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@talissoncosta
talissoncosta requested a review from a team as a code owner January 28, 2026 19:48
@talissoncosta
talissoncosta requested review from Holmus and removed request for a team January 28, 2026 19:48
@vercel

vercel Bot commented Jan 28, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
docs Ready Ready Preview, Comment Jan 29, 2026 2:33pm
2 Skipped Deployments
Project Deployment Review Updated (UTC)
flagsmith-frontend-preview Ignored Ignored Preview Jan 29, 2026 2:33pm
flagsmith-frontend-staging Ignored Ignored Preview Jan 29, 2026 2:33pm

Request Review

Add guidance from Flagsmith blog and onboarding materials:
- Common suffix patterns (_enabled, _limit, _max)
- Questions to consider when naming (impact and context)
- Description best practices section
- Emphasise the "6 months rule" for clarity

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
khvn26
khvn26 previously approved these changes Jan 29, 2026

@khvn26 khvn26 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noice 👌

@talissoncosta
talissoncosta merged commit 6fe6265 into main Jan 30, 2026
12 checks passed
@talissoncosta
talissoncosta deleted the docs/naming-conventions branch January 30, 2026 11:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Add feature flag naming conventions guide

2 participants