Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added section on ownership of flags in environments #389

Merged
merged 2 commits into from
Jul 29, 2024

Conversation

trmartin4
Copy link
Member

@trmartin4 trmartin4 commented Jul 20, 2024

🎟️ Tracking

Feedback from team members on lack of understanding of feature flag ownership between environments

📔 Objective

As we become more mature in our flag usage and have a USDEV environment, I felt it would be helpful to clarify what the expectations are for flag usage in each environment.

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation
    team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed
    issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

Copy link

github-actions bot commented Jul 20, 2024

Logo
Checkmarx One – Scan Summary & Details50a541a8-dd41-433c-81cd-761c95fea7f3

No New Or Fixed Issues Found

@trmartin4 trmartin4 marked this pull request as ready for review July 23, 2024 21:23
@trmartin4 trmartin4 requested a review from a team as a code owner July 23, 2024 21:23
@trmartin4
Copy link
Member Author

@withinfocus when looking at this section, I encountered this text that may no longer be best practice:

Feature flags don’t necessarily have to ever be deleted from LaunchDarkly, just unused. Linking them
to Jira helps create a history of the feature and there are copious logs and audit records online
that can be kept.

Is this still our recommendation? I believe we now recommend that we should delete from LD, right?

:::

The process for updating flag values and the ownership of flag changes depends on the environment
and change as a flag proceeds through our cloud landscape.
Copy link
Contributor

Choose a reason for hiding this comment

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

⛏️ "cloud landscape" sounds beautiful but perhaps too whimsical for docs 😜

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated in 151b341 (#389) to be a bit less poetic.

team. The Engineering Manager of the team is responsible for maintaining and updating flag values.

By default, flags should be **enabled** in the development environment as soon as the flag is
created. This allows the feature to be viewed and exercised by Product, Design, the development
Copy link
Contributor

Choose a reason for hiding this comment

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

⛏️ I don't consider product or design groups to be proper nouns.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed in 151b341 (#389).


### Production environments

In the production environments, the ownership of the flag values is shared between Product and
Copy link
Contributor

Choose a reason for hiding this comment

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

⛏️ Same.

Copy link
Member Author

@trmartin4 trmartin4 Jul 27, 2024

Choose a reason for hiding this comment

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

Fixed in 151b341 (#389).

@withinfocus
Copy link
Contributor

@withinfocus when looking at this section, I encountered this text that may no longer be best practice:

Feature flags don’t necessarily have to ever be deleted from LaunchDarkly, just unused. Linking them
to Jira helps create a history of the feature and there are copious logs and audit records online
that can be kept.

Is this still our recommendation? I believe we now recommend that we should delete from LD, right?

Huh, I don't remember this language being so explicit. We archive flags, not delete them, so maybe that was more the intention.

Copy link

cloudflare-workers-and-pages bot commented Jul 27, 2024

Deploying contributing-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 151b341
Status: ✅  Deploy successful!
Preview URL: https://7eab7c60.contributing-docs.pages.dev
Branch Preview URL: https://clarify-feature-flag-environ.contributing-docs.pages.dev

View logs

@trmartin4
Copy link
Member Author

@withinfocus when looking at this section, I encountered this text that may no longer be best practice:

Feature flags don’t necessarily have to ever be deleted from LaunchDarkly, just unused. Linking them
to Jira helps create a history of the feature and there are copious logs and audit records online
that can be kept.

Is this still our recommendation? I believe we now recommend that we should delete from LD, right?

Huh, I don't remember this language being so explicit. We archive flags, not delete them, so maybe that was more the intention.

I removed that language and instead referenced the archive process at the end of the "Unwinding a feature flag" section.

@trmartin4 trmartin4 requested a review from withinfocus July 27, 2024 21:39
@withinfocus
Copy link
Contributor

I think Todd is out so I am gonna merge this.

@withinfocus withinfocus merged commit cdfe78f into main Jul 29, 2024
7 checks passed
@withinfocus withinfocus deleted the clarify-feature-flag-environments branch July 29, 2024 14:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants