Required comments
Read time: 2 minutes
Last edited: Feb 12, 2024
Required comments is available to customers on an Enterprise plan. To learn more, read about our pricing. To upgrade your plan, contact Sales.
Overview
This topic explains how to use required comments for feature flag changes.
Comments help establish a change history for a feature flag. Requiring members to leave comments when they change flags or segments helps your organization understand why flags or segments look and behave certain ways.
When Require comments is enabled, members must leave a comment to explain their changes when they make changes from the flags list or the segments list in the LaunchDarkly user interface (UI). Comments are not required for changes made with the LaunchDarkly API.
When you require comments in an environment, members must leave a comment when saving any changes to a flag:
Requiring comments
To require comments on flag changes in a new environment:
- Navigate to the Account settings page.
- Click the Projects tab.
- Click on the name of the project you want to create a new environment within. The Environments tab appears.
- Click Create environment. The "Create an environment" panel appears.
- Give your environment a human-readable Name.
- Select the Require comments for flag and segment changes checkbox:
- Click Save environment.
To learn more, read Creating environments.
To require comments in an existing environment:
- Navigate to the Account settings page.
- Click the Projects tab.
- Click on the name of the project you want to require comments for. The Environments tab appears.
- Next to the environment you want to edit, click the overflow menu and choose "Edit environment." The Edit environment panel appears:
- Select the Require comments for flag and segment changes checkbox.
- Click Save environment.
Comments on flag changes are now required for your environment.