Skip to content

Add REVIEW.md with automated PR review guidelines #78

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.

Sign up for GitHub

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

Closed
andypotanin wants to merge 1 commit into from
Closed

Add REVIEW.md with automated PR review guidelines #78

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions REVIEW.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Review Guidelines - worker-php

PHP-FPM + nginx runtime image, `FROM usabilitydynamics/udx-worker` (pinned tag), runs as UID 500. Direct parent of worker-site, therefore of every WordPress tenant.

## Critical Areas (extra scrutiny)

- `bin/start-nginx.sh`, `bin/start-php-fpm.sh`: service startup; must stay fail-fast and UID-500-safe.
- `etc/configs/php/php-fpm.conf` and `etc/configs/php/www.conf`: pool sizing here is consumed by tenant ConfigMaps downstream (see worker-site docs/phpfpm.md). Changing pool defaults changes tenant capacity; require explicit intent and downstream notes.
- `etc/configs/nginx/{nginx.conf,default.conf,snippets/fastcgi-php.conf}`: serving behavior for all PHP tenants; review for exposure (status endpoints, dotfiles, buffer/timeout changes).
- `etc/configs/worker/services.yaml`: supervision contract.
- Dockerfile: pinned `PHP_PACKAGE_VERSION` / `NGINX_VERSION` ARGs stay pinned; `USER` and ownership changes carry the usual UID 500 downstream risk - require worker-site verification.

## Release Model

- Merge to `latest` cuts a Minor release IF the diff touches `bin/**`, `Dockerfile`, `etc/**`, `ci/**`, `src/**`, or `LICENSE`. GitVersion versioning, no changelog: the PR description must state whether worker-site needs a FROM-pin bump.

## Conventions to Enforce

- shellcheck, hadolint, yamllint green; `make test` passes.
- Base-image discipline: new packages/extensions need a downstream consumer, not speculation.
Loading