Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
26 lines (20 loc) · 1.05 KB

CONTRIBUTING.md

File metadata and controls

26 lines (20 loc) · 1.05 KB
Raw

Contributing to Evergreen

Evergreen is a source template for GitHub Agentic Workflows. Changes should keep the install contract, workflow source, generated lockfile, and shared policy documents in sync.

Before Opening a Pull Request

  1. Edit workflows/evergreen.md, not workflows/evergreen.lock.yml directly.

  2. Update the install guide and design docs when behavior or policy changes.

  3. Add or update readiness fixtures when controller state handling changes.

  4. Compile and validate with the pinned release toolchain:

    gh extension install github/gh-aw --pin v0.79.4
gh aw compile --dir workflows --validate --strict --approve --no-check-update
gh aw validate --dir workflows --strict --no-check-update
ruby tests/readiness_state_machine_test.rb
git diff --check

  5. Commit the regenerated workflows/evergreen.lock.yml and any action-lock updates with the source change.

Keep changes focused. Do not include repository credentials, CI logs containing secrets, or private installation policy in issues or pull requests.