Review architecture changes in pull requests for file-based projects.
For Git-projects, architecture changes are reviewed in pull requests like any other code change. Because models and specs are files, reviewers see meaningful diffs and can comment with your existing tools.
The flow
Branch
Create a Git branch for the change.
Edit
Update models and specs in the IDE extension.
Open a pull request
Push the branch and open a PR against your default branch.
Review
Reviewers read the diff of model and spec files and leave comments.
Merge
Merge the PR to make the change canonical.
What reviewers see
| File type | Diff content |
|---|---|
models/*.yaml | Object and link changes |
specs/**/*.mdx | Specification content changes |
project.yaml / meta.yaml | Structure and navigation changes |
Keep PRs scoped to one change so the model and spec diff stays readable. Pair architecture changes with the code that implements them when it helps reviewers.
Cloud projects
For cloud projects, review happens in-app: a branch plus visual diff review. To still land changes in Git, connect the project with GitHub Sync — it mirrors branches to a repository where you can open PRs. There is no in-app PR UI for cloud projects.
Last updated on