Skip to content

Commit c763876

Browse files
authored
Update dependency update guidelines (#5007)
1 parent 4a1a1f0 commit c763876

3 files changed

Lines changed: 15 additions & 9 deletions

File tree

src/handbook/engineering/dependency-updates.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,12 @@ The triage rotation is owned by the engineering team. One engineer takes the slo
1818

1919
Work through Dependabot PRs in this order:
2020

21-
1. **Check for an active npm advisory or breach report on the package.** Look at the package's npm page and the GitHub advisory database before approving. If anything is open against that version, hold the PR until it clears.
22-
2. **Read the release notes for each bump.** Confirm there are no breaking changes that affect how we use the package. Patch and minor bumps still occasionally ship behavior changes worth knowing about.
23-
3. **Merge the safe, small bumps first.** Patch and minor updates with a contained diff and clean release notes go in early. Leave anything with an unusually large diff for closer review.
24-
4. **CI must pass before merging — no exceptions.** A red build on a dependency PR is the signal that something needs investigation, not a bypass.
21+
1. **Wait at least 12 hours after a version is published before merging.** Compromised or broken releases are usually flagged within that window. Merging immediately after publish removes that safety margin.
22+
2. **Check for an active npm advisory or breach report on the package.** Look at the package's npm page and the GitHub advisory database before approving. If anything is open against that version, hold the PR until it clears.
23+
3. **Read the release notes for each bump.** Confirm there are no breaking changes that affect how we use the package. Patch and minor bumps still occasionally ship behavior changes worth knowing about.
24+
4. **Merge the safe, small bumps first.** Patch and minor updates with a contained diff and clean release notes go in early. Leave anything with an unusually large diff for closer review.
25+
5. **CI must pass before merging — no exceptions.** A red build on a dependency PR is the signal that something needs investigation, not a bypass.
26+
6. **Check all repositories.** - Dependabot is active in all our repositiories.
2527

2628
## Major version bumps
2729

src/handbook/engineering/frontend/layouts.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@ title: Front-End Layouts
44

55
# Layouts
66

7-
The frontend has 4 layouts which can be found in `frontend/src/layouts`:
7+
The frontend has 5 layouts which can be found in `frontend/src/layouts`:
88
- Platform
99
- Plain
1010
- Page
1111
- Box
12+
- Immersive
1213

1314
## Layout Variants
1415

@@ -30,6 +31,11 @@ The plain layout serves as a blank structure primarily used for embedded pages o
3031

3132
Has support for alerts and dialog/modals.
3233

34+
### Immersive
35+
The immersive layout serves as the flexbox for the hosted and remoted editor instances.
36+
37+
Does not have support for left drawers. All drawers are shown as a layout over the expert drawer.
38+
3339
### Box
3440
The box layout is used in the initial Setup phase and consists of a boxed layout which guides you through the required steps in configuring the Flow Fuse Application.
3541

src/handbook/engineering/tools.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ When using AI tools for development, never share:
1919
2. Company secrets like API keys, private credentials, etc, etc.
2020
3. Customer code or other assets under NDA
2121

22-
### GitHub Copilot
22+
### Claude Code
2323

24-
GitHub Copilot Business is available to team members by raising an [access request issue](https://github.com/FlowFuse/admin/issues/new?template=access-request.md) and assigning it to the CTO.
25-
26-
Alternatively, individuals can self-purchase Copilot Pro/+ and expense the cost, or qualify for free access due to their role as an Open Source maintainer.
24+
Claude Code is available to team members by raising an [access request issue](https://github.com/FlowFuse/admin/issues/new?template=access-request.md) and assigning it to the CTO.

0 commit comments

Comments
 (0)