Ship Better Code, Faster

Appearance

CI/CD Governance: OrbitTasks Engineering ​

One page. Updated when the team agrees to change it.

Required ​

Things every repo at OrbitTasks must do. These are enforced via [pre-commit hook / branch protection / CI step, pick one].

  • All pull requests must run [list the workflow file path, e.g. .github/workflows/ci.yml] before being merged.
  • The CI workflow must include, at minimum: lint, test, build.
  • All CI jobs must use dependency caching where applicable.
  • All test stages must run in CI, not just locally.
  • Branch protection on main requires CI to pass.

Things we encourage but don't enforce.

  • Tests should run in parallel via a matrix strategy if total runtime exceeds 5 minutes.
  • Test files should be co-located with the code they test where the language allows.
  • Long-running integration tests should run on a separate, optional workflow.

Forbidden ​

Things we will revert.

  • Skipping CI by force-pushing to main.
  • Disabling test runs via xit, xdescribe, or .skip without an accompanying tracked issue.
  • Bypassing branch protection without a logged reason.

Enforcement ​

  • Branch protection on main is configured via the GitHub UI; review quarterly.
  • The CI workflow file itself is owned by the Platform Engineering team.
  • Violations are addressed in PR review or in retrospective; not in real time.

Last verified: [date]Owner: [name / team]