Add documentation on hotfixing in GovPress #1469
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for laughing-payne-b9fbd2 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Notes on how to avoid hotfixing and how to reduce the risk of it when we we do hotfix. Follow-up to INC-203 https://app.incident.io/dxw/incidents/203
snim2
force-pushed
the
feature/add-govpress-hotfix-notes
branch
from
a359986 to
e492134
Compare
RobjS
approved these changes
Jan 6, 2025
src/govpress-unit/hotfixing.md
Outdated
|
|
||
| In this case, we should first consider factoring our code to avoid hotfixes. For example, can new features be designed as a new plugin, which can be deactivated by default? Can a theme rebuild be placed in a new theme? | ||
|
|
||
| An alternative to a new plugin or theme is to guard the new feature with a feature flag which can be set to activate the feature in staging but not in production. This is something that is much easier to implement if your code is well factored, according to the [SOLID principles of OOP](https://en.wikipedia.org/wiki/SOLID). |
There was a problem hiding this comment.
Non-blocking suggestion: would it be useful to include a link to an explainer about feature flags here? (e.g. https://blog.jetbrains.com/space/2022/06/16/feature-flags/). Some members of the team might not be familiar with the concept.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Notes on how to avoid hotfixing and how to reduce
the risk of it when we we do hotfix.
Follow-up to INC-203 https://app.incident.io/dxw/incidents/203
Note: This should probably be followed by a PR to group the technical notes into a subfolder