Nest Engineering Docs
Handbook

Reviews & merging

Pull request guidelines

Pull requests

  • Keep PRs focused and small; split cross-service changes when possible.
  • One tracking issue should map to one PR.
  • Include purpose, summary of changes, and manual test notes.
  • Attach logs/screenshots for UI or operational changes when relevant.
  • Update docs when behavior or endpoints change.

Review expectations

  • At least one reviewer approval before merge.
  • If the PR author is not a primary or secondary owner, require approval from the service/job/app owner.
  • Check for schema changes, backward compatibility, and pipeline impacts.
  • Validate new endpoints include status codes and response models.

Titles and merges

  • Always squash and merge (no merge commits).
  • PR titles and the final squash commit must follow Conventional Commits: type(scope): description.
  • Include the PR number in the squash commit title (e.g., feat(handler): add retry (#123)).
  • Allowed types: feat, fix, chore, refactor, docs, test, perf.
  • The PR title lint workflow enforces this format.

Last updated on