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

Add Feature Flags article #559

Merged
merged 12 commits into from
May 30, 2024
Merged

Add Feature Flags article #559

merged 12 commits into from
May 30, 2024

Conversation

aduth
Copy link
Member

@aduth aduth commented May 30, 2024

🛠 Summary of changes

Adds a new article describing the purpose and lifecycle of feature flags in Rails applications.

This was an action item from the 2024-05-29 Engineering Huddle meeting.

📜 Testing Plan

  1. Go to https://federalist-7d0b2b76-42fc-4df1-9825-8c3cd77e0a15.sites.pages.cloud.gov/preview/gsa-tts/identity-handbook/aduth-feature-flags/articles/appdev-feature-flags.html
  2. Verify that the content includes everything you'd expect to learn about how we use feature flags, as if you were a new developer to the team

mitchellhenke
mitchellhenke previously approved these changes May 30, 2024
Copy link
Contributor

@mitchellhenke mitchellhenke left a comment

Choose a reason for hiding this comment

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

This is really great!

zachmargolis
zachmargolis previously approved these changes May 30, 2024
Copy link
Contributor

@zachmargolis zachmargolis left a comment

Choose a reason for hiding this comment

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

LGTM!

_articles/appdev-feature-flags.md Show resolved Hide resolved
n1zyy
n1zyy previously approved these changes May 30, 2024
Copy link
Contributor

@n1zyy n1zyy left a comment

Choose a reason for hiding this comment

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

This is great stuff.

I left a lengthy commentary on a bullet point where the wording doesn't feel quite right, but ironically couldn't quite get the wording or even main idea of my comment quite right. In any event, it is not particularly important. I left it in case it resonates and leads you to where I couldn't quite get.

Otherwise, feel free to just ignore it. This is a fantastic writeup.

_articles/appdev-feature-flags.md Outdated Show resolved Hide resolved
- **Pros:**
- This helps ensure broad test coverage for your new feature in continuous integratration (CI) builds.
- You will want to ensure that a feature flag is enabled in test environments before going live in production, so enabling it early saves a future step.
- Enabling your new feature by default may cause existing tests to fail where it breaks expectations of how a user proceeds through the application, but this is inevitable and easier to address earlier in the feature development than later.
Copy link
Contributor

Choose a reason for hiding this comment

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

Actually, does this relate to what I'm saying above, too? This bullet point technically starts off with a "Con," but addresses the silver lining. I feel like the point behind both of these is that enabling it in non-prod environments helps spot issues sooner, when they're easier to address.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, I see what you're saying here, and I waffled a bit on this too. I tried to rephrase it a bit in c090e92, let me know if that helps make it more readable.

_articles/appdev-feature-flags.md Show resolved Hide resolved
_articles/appdev-feature-flags.md Show resolved Hide resolved
@aduth aduth dismissed stale reviews from n1zyy, zachmargolis, and mitchellhenke via ab2e89c May 30, 2024 16:27
@aduth aduth requested review from n1zyy and zachmargolis May 30, 2024 17:05
zachmargolis
zachmargolis previously approved these changes May 30, 2024
@aduth aduth merged commit e2f956f into main May 30, 2024
5 checks passed
@aduth aduth deleted the aduth-feature-flags branch May 30, 2024 17:10
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.

None yet

4 participants