Skip to content

pull-request-workflow.md

Latest commit

 

History

History
83 lines (59 loc) · 2.61 KB

pull-request-workflow.md

File metadata and controls

83 lines (59 loc) · 2.61 KB
Raw

Pull Request Workflow

OpenSyria Website is maintainer-led. Public issues and small corrections are welcome, but broad implementation work should be discussed before a pull request is opened.

Branches

Use short, descriptive branch names:

fix/header-focus-state
docs/update-local-setup
chore/update-dependencies

Scope

Good pull requests are focused and easy to review. Keep unrelated refactors, formatting churn, generated files, and dependency updates out of feature or bug-fix PRs.

Dataset record corrections, missing records, source disagreements, and dataset schema proposals belong in the relevant dataset repository.

Before Opening

Before opening a PR:

  • make sure the change belongs in website,
  • keep the change focused,
  • update docs when commands, configuration, routes, content, analytics, or deployment steps change,
  • include screenshots or notes for visual changes,
  • consider keyboard, screen-reader, focus, contrast, and responsive behavior,
  • do not commit secrets, local .env files, private data, or generated local artifacts,
  • avoid new production dependencies unless clearly necessary.

Validation

Run:

pnpm verify

For focused local work:

pnpm check
pnpm typecheck
pnpm test:admissions
pnpm test:results
pnpm build

Use pnpm check:write for Biome formatting and safe fixes. Use pnpm check:write:unsafe only when intentionally accepting unsafe Biome fixes.

Changes to public build or hosting requirements should also update Deployment. Keep live deployment tooling and operator procedures in private operational storage.

Dependency Updates

Dependabot groups npm updates into one weekly pull request so package.json and pnpm-lock.yaml are reviewed as one dependency graph. Do not merge dependency pull requests until pnpm install --frozen-lockfile and pnpm verify pass on the pull request branch.

If dependency pull requests are manually combined, regenerate the lockfile with the pinned pnpm version before merging. A manifest-only bump will fail CI and should not be pushed to main.

Commit Messages

Use Conventional Commits:

feat: add dataset browser shell
fix: correct navigation focus state
docs: update contribution notes
chore: update dependencies

Release automation reads Conventional Commits from main. Release-worthy changes such as feat:, fix:, perf:, and breaking changes are collected by release-please into a release pull request. See Releases. pnpm typecheck generates Next.js route and image declarations before running TypeScript, so clean checkouts receive the same checks as local builds.