Skip to content

Latest commit

 

History

History
96 lines (80 loc) · 5.13 KB

CONTRIBUTING.md

File metadata and controls

96 lines (80 loc) · 5.13 KB

Contributing to OpenWork

Contributor License Agreement and Developer Certificate of Origin

Contributions to this repository are subject to the Developer Certificate of Origin, or the Individual or Corporate Contributor License Agreement, depending on where the contribution is made and on whose behalf, unless otherwise agreed with Different AI, Inc. in writing:

By contributing, you are deemed to have accepted the agreement that applies to your contribution. There is nothing separate to sign. You keep ownership of your contribution; you grant Different AI, Inc. the permissions in the applicable agreement, and those permissions cannot be withdrawn.

ee/ needs a CLA rather than the DCO because the code there is distributed under the OpenWork EE License, not an open source license, and each released version later converts to MIT. The CLA grants a license broad enough to do both.

To put an overarching Corporate CLA in place for everyone contributing on behalf of your organization, email team@openworklabs.com.

This notice should stay as the first item in this file.

How CI runs on a pull request from a fork

  1. Automatic checks, on every push. Before any of your code runs, a screen reads your changes. It blocks hidden or malformed characters (invisible Unicode, bidirectional overrides, look-alike letters, invalid UTF-8), which you must remove. It flags for a maintainer: dependency or lockfile changes, database schema or migration changes, binary files, code that looks encoded or obfuscated, and text that tries to give instructions to an AI reviewer. A comment on the pull request lists what it found. Nothing else runs yet.
  2. Maintainer review and /test. A maintainer reviews your changes and comments /test. That marks the commit they reviewed.
  3. Tests. The repository approves the waiting test runs for that exact commit. Fork tests have no secrets. Before approving the PR, a maintainer checks the screen results on the current head and the required openwork-tests-required CI check. Screen results are advisory, not a separate required merge status. If you push again, screening runs again and a maintainer reviews the new commits before /test. Prefer /test <full-head-sha> to name the commit you actually reviewed (explicit SHAs must be all 40 characters); a plain /test is refused if its head was pushed after the comment or its push time cannot be established.

This contributor flow is fork-only, including forks opened by bots. Same-repository PRs use normal CI and review; they do not need /test or a contributor merge status. The repository must require workflow approval for all outside collaborators, not just first-time contributors. Maintainers must not bypass the reviewed-head check by approving fork workflows directly. Required CI and approval of the latest push still apply; keep the CODEOWNERS-required rule enabled and verify that owners cover sensitive paths (the setting alone does not create coverage). Trusted repository members/collaborators can be exempt from GitHub's fork-run approval setting; see the administrator caveats below. Large fork diffs (300 or more changed files) must be carried to a same-repository branch because GitHub's immutable comparison API truncates file lists at that limit.

For repository administrators: fork gate deployment and ruleset migration.

Changes to CI or agent configuration (.github/, .opencode/, opencode.json, agent skills) can't be tested from a fork. A maintainer moves those commits to a branch in this repository, keeping you as the author.

Paid work

If you are contributing as part of paid work, a work trial, or on behalf of an employer, make sure a signed agreement covering intellectual property assignment is in place with Different AI, Inc. before your first pull request — ask your contact at OpenWork if you are unsure. Maintainers will not merge substantive contributions from paid engagements without one.

Practical notes

  • Use pnpm, never npm or yarn.
  • Keep diffs as small as possible; propose the simpler solution.
  • Runtime-observable changes need test evidence on the PR (see AGENTS.md).
  • Never commit secrets, credentials, or personal data.